{ "version":"2.0", "metadata":{ "apiVersion":"2022-07-26", "auth":[ "aws.auth#sigv4a", "aws.auth#sigv4" ], "endpointPrefix":"partnercentral-prm", "protocol":"smithy-rpc-v2-cbor", "protocols":["smithy-rpc-v2-cbor"], "serviceFullName":"Partner Central Revenue Measurement API", "serviceId":"PartnerCentral Revenue Measurement", "signatureVersion":"v4", "signingName":"partnercentral", "targetPrefix":"PartnerCentralRevenueMeasurement", "uid":"partnercentral-revenue-measurement-2022-07-26" }, "operations":{ "CreateMarketplaceRevenueShare":{ "name":"CreateMarketplaceRevenueShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMarketplaceRevenueShareInput"}, "output":{"shape":"CreateMarketplaceRevenueShareOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a new marketplace revenue share resource in the specified catalog.

", "idempotent":true }, "CreateMarketplaceRevenueShareAllocation":{ "name":"CreateMarketplaceRevenueShareAllocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMarketplaceRevenueShareAllocationInput"}, "output":{"shape":"CreateMarketplaceRevenueShareAllocationOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Creates a new marketplace revenue share allocation for the specified product.

", "idempotent":true }, "CreateRevenueAttribution":{ "name":"CreateRevenueAttribution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRevenueAttributionInput"}, "output":{"shape":"CreateRevenueAttributionOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a new revenue attribution record in the specified catalog.

", "idempotent":true }, "GetMarketplaceRevenueShare":{ "name":"GetMarketplaceRevenueShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMarketplaceRevenueShareInput"}, "output":{"shape":"GetMarketplaceRevenueShareOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Retrieves the details of a specific marketplace revenue share.

", "readonly":true }, "GetMarketplaceRevenueShareAllocation":{ "name":"GetMarketplaceRevenueShareAllocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMarketplaceRevenueShareAllocationInput"}, "output":{"shape":"GetMarketplaceRevenueShareAllocationOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the details of a specific marketplace revenue share allocation.

", "readonly":true }, "GetRevenueAttribution":{ "name":"GetRevenueAttribution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRevenueAttributionInput"}, "output":{"shape":"GetRevenueAttributionOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the details of a specific revenue attribution.

", "readonly":true }, "GetRevenueAttributionAllocation":{ "name":"GetRevenueAttributionAllocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRevenueAttributionAllocationInput"}, "output":{"shape":"GetRevenueAttributionAllocationOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves a single allocation by its RevenueAttributionAllocationId. Supports optional point-in-time version queries.

", "readonly":true }, "GetRevenueAttributionAllocationsTask":{ "name":"GetRevenueAttributionAllocationsTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRevenueAttributionAllocationsTaskInput"}, "output":{"shape":"GetRevenueAttributionAllocationsTaskOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the current status of a previously submitted allocations task. When COMPLETE, includes the latest revision. When FAILED, includes error details.

", "readonly":true }, "ListMarketplaceRevenueShareAllocations":{ "name":"ListMarketplaceRevenueShareAllocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMarketplaceRevenueShareAllocationsInput"}, "output":{"shape":"ListMarketplaceRevenueShareAllocationsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range. Supports historical reads at a specific share revision.

", "readonly":true }, "ListMarketplaceRevenueShares":{ "name":"ListMarketplaceRevenueShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMarketplaceRevenueSharesInput"}, "output":{"shape":"ListMarketplaceRevenueSharesOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns a paginated list of marketplace revenue shares with optional filters.

", "readonly":true }, "ListRevenueAttributionAllocations":{ "name":"ListRevenueAttributionAllocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRevenueAttributionAllocationsInput"}, "output":{"shape":"ListRevenueAttributionAllocationsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.

", "readonly":true }, "ListRevenueAttributions":{ "name":"ListRevenueAttributions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRevenueAttributionsInput"}, "output":{"shape":"ListRevenueAttributionsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a paginated list of revenue attributions with optional filters.

", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns the tags associated with the specified resource.

", "readonly":true }, "StartRevenueAttributionAllocationsTask":{ "name":"StartRevenueAttributionAllocationsTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartRevenueAttributionAllocationsTaskInput"}, "output":{"shape":"StartRevenueAttributionAllocationsTaskOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Submits a batch of up to 250 allocation changes (CREATE and/or UPDATE) for asynchronous processing. Returns a TaskId for tracking.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceInput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Adds or overwrites one or more tags for the specified resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceInput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Removes one or more tags from the specified resource.

" }, "UpdateMarketplaceRevenueShareAllocation":{ "name":"UpdateMarketplaceRevenueShareAllocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMarketplaceRevenueShareAllocationInput"}, "output":{"shape":"UpdateMarketplaceRevenueShareAllocationOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Updates an existing marketplace revenue share allocation. Supports modifying effective dates, revenue share percentage, and status with time-based mutability rules.

", "idempotent":true }, "UpdateRevenueAttribution":{ "name":"UpdateRevenueAttribution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRevenueAttributionInput"}, "output":{"shape":"UpdateRevenueAttributionOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates an existing revenue attribution record.

", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{"shape":"String"}, "Reason":{ "shape":"AccessDeniedExceptionReason", "documentation":"

The reason for the access denial.

" } }, "documentation":"

The request was denied due to insufficient permissions.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessDeniedExceptionReason":{ "type":"string", "enum":["ACCESS_DENIED"] }, "AllocationCount":{ "type":"integer", "box":true, "min":0 }, "AllocationEffectiveDateString":{ "type":"string", "max":10, "min":10, "pattern":"\\d{4}-\\d{2}-\\d{2}" }, "AllocationStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "AttributionSortBy":{ "type":"string", "enum":["LastModifiedDate"] }, "AttributionSummary":{ "type":"structure", "required":["TenancyModel"], "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the revenue attribution.

" }, "Id":{ "shape":"RevenueAttributionId", "documentation":"

The unique identifier of the revenue attribution.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the revenue attribution belongs to.

" }, "Name":{ "shape":"AttributionSummaryNameString", "documentation":"

The display name of the revenue attribution.

" }, "TenancyModel":{ "shape":"TenancyModel", "documentation":"

The tenancy model for this revenue attribution.

" }, "MarketplaceProduct":{ "shape":"MarketplaceProductSummary", "documentation":"

The AWS Marketplace product attributes associated with this attribution, if set.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the revenue attribution was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the revenue attribution was last modified.

" }, "LatestRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the revenue attribution resource.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The date from which this revenue attribution is effective, derived from the earliest allocation start date (YYYY-MM-DD).

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The date until which this revenue attribution is effective, derived from the latest allocation end date (YYYY-MM-DD).

" }, "TotalActiveRevenueAttributionAllocationCount":{ "shape":"AllocationCount", "documentation":"

The total number of allocations under this revenue attribution whose Status is ACTIVE.

" }, "TotalRevenueAttributionAllocationCount":{ "shape":"AllocationCount", "documentation":"

The total number of allocations under this revenue attribution, counting both ACTIVE and INACTIVE.

" } }, "documentation":"

Summary representation of a revenue attribution returned in list operations.

" }, "AttributionSummaryNameString":{ "type":"string", "max":128, "min":1 }, "CatalogName":{ "type":"string", "enum":[ "AWS", "Sandbox" ] }, "ClientToken":{ "type":"string", "max":64, "min":1, "pattern":"[!-~]{1,64}" }, "ConflictException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{"shape":"String"}, "Reason":{ "shape":"ConflictExceptionReason", "documentation":"

The reason for the conflict.

" } }, "documentation":"

The request could not be completed due to a conflict with the current state of the resource.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ConflictExceptionReason":{ "type":"string", "enum":[ "CONFLICT_CLIENT_TOKEN", "CONCURRENT_MODIFICATION", "RESOURCE_ALREADY_EXISTS", "REVISION_MISMATCH" ] }, "CreateMarketplaceRevenueShareAllocationInput":{ "type":"structure", "required":[ "Catalog", "ProductId", "EffectiveFrom", "RevenueSharePercent" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog in which to create the allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier for the parent revenue share.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique token to ensure idempotency of the create request.

", "idempotencyToken":true }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date for the allocation. Must be the first day of a month.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date for the allocation. Must be the last day of a month (YYYY-MM-DD). Omit for open-ended allocations.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The revenue share percentage for this allocation.

" } } }, "CreateMarketplaceRevenueShareAllocationOutput":{ "type":"structure", "required":[ "MarketplaceRevenueShareAllocationId", "ProductId", "Arn", "EffectiveFrom", "RevenueSharePercent", "Status" ], "members":{ "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The unique identifier of the newly created allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the allocation.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date of the allocation.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date of the allocation, or null if open-ended.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The revenue share percentage.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

The status of the allocation.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was last modified.

" }, "LatestMarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the parent marketplace revenue share.

" } } }, "CreateMarketplaceRevenueShareInput":{ "type":"structure", "required":[ "Catalog", "ProductId" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog in which to create the marketplace revenue share.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique token to ensure idempotency of the create request.

", "idempotencyToken":true }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier for this revenue share.

" }, "Tags":{ "shape":"MarketplaceRevenueShareTagList", "documentation":"

Tags to associate with the marketplace revenue share upon creation.

" } } }, "CreateMarketplaceRevenueShareOutput":{ "type":"structure", "required":[ "ProductId", "Arn" ], "members":{ "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier of the newly created revenue share.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the newly created marketplace revenue share.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the marketplace revenue share belongs to.

" }, "ProductCode":{ "shape":"String", "documentation":"

The AWS Marketplace product code.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was last modified.

" }, "Revision":{ "shape":"CreateMarketplaceRevenueShareOutputRevisionInteger", "documentation":"

The revision number of the newly created marketplace revenue share.

" } } }, "CreateMarketplaceRevenueShareOutputRevisionInteger":{ "type":"integer", "box":true, "min":1 }, "CreateRevenueAttributionInput":{ "type":"structure", "required":[ "Catalog", "Name", "TenancyModel" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog in which to create the revenue attribution.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique token to ensure idempotency of the create request.

", "idempotencyToken":true }, "Name":{ "shape":"CreateRevenueAttributionInputNameString", "documentation":"

The name of the revenue attribution. Must be unique within the catalog and the partner's account.

" }, "Description":{ "shape":"CreateRevenueAttributionInputDescriptionString", "documentation":"

A description of the revenue attribution.

" }, "TenancyModel":{ "shape":"TenancyModel", "documentation":"

The tenancy model for this revenue attribution.

" }, "ProductIdentifier":{ "shape":"CreateRevenueAttributionInputProductIdentifierString", "documentation":"

The unique product identifier in AWS Marketplace. Accepts a product entity ID (e.g., prod-abc123def4567) or a product ARN.

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags to associate with the revenue attribution upon creation.

" } } }, "CreateRevenueAttributionInputDescriptionString":{ "type":"string", "max":1024, "min":0, "pattern":"[\\x20-\\x7E]*" }, "CreateRevenueAttributionInputNameString":{ "type":"string", "max":128, "min":1, "pattern":"[\\x20-\\x7E]+" }, "CreateRevenueAttributionInputProductIdentifierString":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-:/.]+" }, "CreateRevenueAttributionOutput":{ "type":"structure", "required":[ "Id", "Arn", "TenancyModel" ], "members":{ "Id":{ "shape":"RevenueAttributionId", "documentation":"

The unique identifier of the newly created revenue attribution.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the newly created revenue attribution.

" }, "Name":{ "shape":"String", "documentation":"

The name of the revenue attribution.

" }, "Description":{ "shape":"String", "documentation":"

The description of the revenue attribution.

" }, "TenancyModel":{ "shape":"TenancyModel", "documentation":"

The tenancy model for this revenue attribution.

" }, "MarketplaceProduct":{ "shape":"MarketplaceProductSummary", "documentation":"

The associated AWS Marketplace product listing, if set at creation.

" }, "Revision":{ "shape":"RevisionToken", "documentation":"

The revision of the newly created attribution resource.

" } } }, "CustomerAwsAccountId":{ "type":"string", "max":12, "min":12, "pattern":"[0-9]{12}", "sensitive":true }, "CustomerAwsAccountIdFilterList":{ "type":"list", "member":{"shape":"CustomerAwsAccountId"}, "max":50, "min":1 }, "EntityIdentifier":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-:/.]+" }, "EntityIdentifierFilterList":{ "type":"list", "member":{"shape":"EntityIdentifier"}, "max":50, "min":1 }, "EntityType":{ "type":"string", "enum":[ "OFFER", "OPPORTUNITY" ] }, "EntityTypeFilterList":{ "type":"list", "member":{"shape":"EntityType"}, "max":2, "min":1 }, "FieldValidationCode":{ "type":"string", "enum":[ "REQUIRED_FIELD_MISSING", "DUPLICATE_VALUE", "INVALID_VALUE", "INVALID_STRING_FORMAT", "TOO_MANY_VALUES", "ACTION_NOT_PERMITTED", "INVALID_ENUM_VALUE", "INVALID_NUMBER_FORMAT", "INVALID_STRING_LENGTH" ] }, "GetMarketplaceRevenueShareAllocationInput":{ "type":"structure", "required":[ "Catalog", "ProductId", "MarketplaceRevenueShareAllocationId" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the allocation belongs to.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier of the parent revenue share.

" }, "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The unique identifier of the allocation to retrieve.

" }, "MarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

The revision of the parent marketplace revenue share at which to retrieve the allocation. Omit to return the latest.

" } } }, "GetMarketplaceRevenueShareAllocationOutput":{ "type":"structure", "required":[ "MarketplaceRevenueShareAllocationId", "ProductId", "Arn", "EffectiveFrom", "RevenueSharePercent", "Status" ], "members":{ "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The unique identifier of the allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the allocation.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date of the allocation.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date of the allocation, or null if open-ended.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The revenue share percentage.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

The status of the allocation.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was last modified.

" }, "LatestMarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the parent marketplace revenue share.

" } } }, "GetMarketplaceRevenueShareInput":{ "type":"structure", "required":[ "Catalog", "ProductId" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the marketplace revenue share belongs to.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier of the revenue share to retrieve.

" }, "Revision":{ "shape":"GetMarketplaceRevenueShareInputRevisionInteger", "documentation":"

The revision of the marketplace revenue share to retrieve. Omit to return the latest revision.

" } } }, "GetMarketplaceRevenueShareInputRevisionInteger":{ "type":"integer", "box":true, "min":1 }, "GetMarketplaceRevenueShareOutput":{ "type":"structure", "required":[ "ProductId", "Arn", "Catalog" ], "members":{ "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier of the revenue share.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the marketplace revenue share.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the marketplace revenue share belongs to.

" }, "ProductCode":{ "shape":"String", "documentation":"

The AWS Marketplace product code.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was last modified.

" }, "Revision":{ "shape":"GetMarketplaceRevenueShareOutputRevisionInteger", "documentation":"

The revision number of the retrieved marketplace revenue share.

" }, "LatestRevision":{ "shape":"GetMarketplaceRevenueShareOutputLatestRevisionInteger", "documentation":"

The latest revision number of the marketplace revenue share.

" }, "TotalActiveMarketplaceRevenueShareAllocationCount":{ "shape":"Integer", "documentation":"

The number of active allocations under this marketplace revenue share.

" }, "TotalMarketplaceRevenueShareAllocationCount":{ "shape":"Integer", "documentation":"

The total number of allocations under this marketplace revenue share.

" } } }, "GetMarketplaceRevenueShareOutputLatestRevisionInteger":{ "type":"integer", "box":true, "min":1 }, "GetMarketplaceRevenueShareOutputRevisionInteger":{ "type":"integer", "box":true, "min":1 }, "GetRevenueAttributionAllocationInput":{ "type":"structure", "required":[ "Catalog", "RevenueAttributionIdentifier", "RevenueAttributionAllocationId" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that contains the resource.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier.

" }, "RevenueAttributionAllocationId":{ "shape":"RevenueAttributionAllocationId", "documentation":"

The allocation identifier.

" }, "RevenueAttributionRevision":{ "shape":"RevisionToken", "documentation":"

Point-in-time revision number to query.

" } } }, "GetRevenueAttributionAllocationOutput":{ "type":"structure", "required":[ "RevenueAttributionAllocationId", "RevenueAttributionIdentifier", "EntityType", "EntityIdentifier", "CustomerAwsAccountId", "RevenueSharePercent", "EffectiveFrom", "EffectiveUntil", "Status", "CreatedDate", "LastModifiedDate", "RevenueAttributionRevision", "RevenueAttributionLatestRevision" ], "members":{ "RevenueAttributionAllocationId":{ "shape":"RevenueAttributionAllocationId", "documentation":"

Unique allocation identifier.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier.

" }, "EntityType":{ "shape":"EntityType", "documentation":"

The type of the associated deal entity.

" }, "EntityIdentifier":{ "shape":"EntityIdentifier", "documentation":"

The unique identifier of the associated deal entity.

" }, "EntityName":{ "shape":"String", "documentation":"

The display name of the associated deal entity.

" }, "CustomerAwsAccountId":{ "shape":"CustomerAwsAccountId", "documentation":"

The customer AWS account ID for this associated deal entity.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

Revenue share percentage.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

First day of the effective month.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

Last day of the effective month.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

Current allocation status.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

When the allocation was first created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

When the allocation was last modified.

" }, "RevenueAttributionRevision":{ "shape":"RevisionToken", "documentation":"

The revision of this allocation version.

" }, "RevenueAttributionLatestRevision":{ "shape":"RevisionToken", "documentation":"

The latest committed revision.

" } } }, "GetRevenueAttributionAllocationsTaskInput":{ "type":"structure", "required":[ "Catalog", "RevenueAttributionIdentifier" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that contains the resource.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier.

" } } }, "GetRevenueAttributionAllocationsTaskOutput":{ "type":"structure", "required":[ "TaskId", "Status", "Catalog", "RevenueAttributionArn", "StartedAt", "TotalRevenueAttributionAllocationRecords" ], "members":{ "TaskId":{ "shape":"RevenueAttributionAllocationTaskId", "documentation":"

The unique identifier for the asynchronous task.

" }, "Status":{ "shape":"RevenueAttributionAllocationTaskStatus", "documentation":"

Current task status.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog used for this task.

" }, "RevenueAttributionArn":{ "shape":"String", "documentation":"

ARN of the revenue attribution resource.

" }, "StartedAt":{ "shape":"Timestamp", "documentation":"

When processing started.

" }, "EndedAt":{ "shape":"Timestamp", "documentation":"

When processing ended. Only present when COMPLETE or FAILED.

" }, "TotalRevenueAttributionAllocationRecords":{ "shape":"Integer", "documentation":"

Total revenue attribution allocation records in the batch.

" }, "Description":{ "shape":"String", "documentation":"

Human-readable description, if provided at creation.

" }, "RevenueAttributionLatestRevision":{ "shape":"RevisionToken", "documentation":"

The revision number assigned to this batch. Only present when COMPLETE.

" }, "ErrorDetailList":{ "shape":"RevenueAttributionAllocationErrorDetailList", "documentation":"

All errors discovered during async processing. Only present when FAILED.

" } } }, "GetRevenueAttributionInput":{ "type":"structure", "required":[ "Catalog", "Identifier" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the revenue attribution belongs to.

" }, "Identifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The unique identifier of the revenue attribution to retrieve. Accepts a direct ID or ARN.

" }, "Revision":{ "shape":"RevisionToken", "documentation":"

The revision of the attribution to retrieve. Omit to return the latest revision.

" } } }, "GetRevenueAttributionOutput":{ "type":"structure", "required":[ "Arn", "Id", "Catalog", "TenancyModel" ], "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the revenue attribution.

" }, "Id":{ "shape":"RevenueAttributionId", "documentation":"

The unique identifier of the revenue attribution.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the revenue attribution belongs to.

" }, "Name":{ "shape":"GetRevenueAttributionOutputNameString", "documentation":"

The display name of the revenue attribution.

" }, "Description":{ "shape":"GetRevenueAttributionOutputDescriptionString", "documentation":"

A description of the revenue attribution.

" }, "TenancyModel":{ "shape":"TenancyModel", "documentation":"

The tenancy model for this revenue attribution.

" }, "MarketplaceProduct":{ "shape":"MarketplaceProductSummary", "documentation":"

The associated AWS Marketplace product listing, if set.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the revenue attribution was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the revenue attribution was last modified.

" }, "Revision":{ "shape":"RevisionToken", "documentation":"

The revision of the retrieved attribution.

" }, "LatestRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the attribution.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The date from which this revenue attribution is effective, derived from the earliest allocation start date (YYYY-MM-DD).

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The date until which this revenue attribution is effective, derived from the latest allocation end date (YYYY-MM-DD).

" }, "TotalActiveRevenueAttributionAllocationCount":{ "shape":"AllocationCount", "documentation":"

The total number of allocations under this revenue attribution whose Status is ACTIVE.

" }, "TotalRevenueAttributionAllocationCount":{ "shape":"AllocationCount", "documentation":"

The total number of allocations under this revenue attribution, counting both ACTIVE and INACTIVE.

" } } }, "GetRevenueAttributionOutputDescriptionString":{ "type":"string", "max":1024, "min":0 }, "GetRevenueAttributionOutputNameString":{ "type":"string", "max":128, "min":1 }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

An internal server error occurred. Retry your request.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListMarketplaceRevenueShareAllocationsInput":{ "type":"structure", "required":[ "Catalog", "ProductId" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog containing the allocations.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier for the parent revenue share.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

Filter by allocation status.

" }, "AfterEffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

Inclusive lower bound for EffectiveFrom date filter.

" }, "BeforeEffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

Exclusive upper bound for EffectiveFrom date filter (half-open range).

" }, "SortBy":{ "shape":"MarketplaceRevenueShareAllocationSortField", "documentation":"

The field to sort marketplace revenue share allocations by.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The direction to sort results. Defaults to DESCENDING.

" }, "MaxResults":{ "shape":"ListMarketplaceRevenueShareAllocationsInputMaxResultsInteger", "documentation":"

Maximum number of results per page.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token from a previous response.

" }, "MarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

Optional share revision for historical list. Returns allocations as they existed at this revision.

" } } }, "ListMarketplaceRevenueShareAllocationsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListMarketplaceRevenueShareAllocationsOutput":{ "type":"structure", "required":["MarketplaceRevenueShareAllocationSummaries"], "members":{ "MarketplaceRevenueShareAllocationSummaries":{ "shape":"MarketplaceRevenueShareAllocationSummaryList", "documentation":"

The list of allocation summaries for the current page.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token for the next page. Absent if no more results.

" } } }, "ListMarketplaceRevenueSharesInput":{ "type":"structure", "required":["Catalog"], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog to list marketplace revenue shares from.

" }, "ProductIds":{ "shape":"MarketplaceProductIdList", "documentation":"

Filter results to only include shares with these product identifiers.

" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Filter results to only include shares with these product codes.

" }, "MaxResults":{ "shape":"ListMarketplaceRevenueSharesInputMaxResultsInteger", "documentation":"

The maximum number of results to return in a single call.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for pagination. Use the value returned in the previous response to retrieve the next page.

" }, "SortBy":{ "shape":"MarketplaceRevenueShareSortBy", "documentation":"

The field to sort marketplace revenue shares by.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The direction to sort results.

" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"

Filter results to only include marketplace revenue shares created after this timestamp.

" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"

Filter results to only include marketplace revenue shares created before this timestamp.

" } } }, "ListMarketplaceRevenueSharesInputMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListMarketplaceRevenueSharesOutput":{ "type":"structure", "required":["MarketplaceRevenueShareSummaries"], "members":{ "MarketplaceRevenueShareSummaries":{ "shape":"MarketplaceRevenueShareSummaryList", "documentation":"

The list of marketplace revenue share summaries.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for pagination. Present if there are more results available.

" } } }, "ListRevenueAttributionAllocationsInput":{ "type":"structure", "required":[ "Catalog", "RevenueAttributionIdentifier" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that contains the resource.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier to query.

" }, "EntityTypeFilters":{ "shape":"EntityTypeFilterList", "documentation":"

Filter by deal entity types.

" }, "EntityIdentifierFilters":{ "shape":"EntityIdentifierFilterList", "documentation":"

Filter by deal entity identifiers.

" }, "CustomerAwsAccountIdFilters":{ "shape":"CustomerAwsAccountIdFilterList", "documentation":"

Filter by customer AWS account IDs for associated deal entities.

" }, "StatusFilter":{ "shape":"AllocationStatus", "documentation":"

Filter by allocation status.

" }, "AfterEffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

Inclusive lower bound for EffectiveFrom date filter.

" }, "BeforeEffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

Exclusive upper bound for EffectiveFrom date filter (half-open range).

" }, "AfterEffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

Inclusive lower bound for EffectiveUntil date filter.

" }, "BeforeEffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

Exclusive upper bound for EffectiveUntil date filter (half-open range).

" }, "SortBy":{ "shape":"RevenueAttributionAllocationSortField", "documentation":"

Field to sort by.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

Sort direction. Defaults to ASCENDING.

" }, "RevenueAttributionRevision":{ "shape":"RevisionToken", "documentation":"

Point-in-time revision number to query.

" }, "MaxResults":{ "shape":"ListRevenueAttributionAllocationsInputMaxResultsInteger", "documentation":"

Maximum results per page.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token from previous response.

" } } }, "ListRevenueAttributionAllocationsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":500, "min":1 }, "ListRevenueAttributionAllocationsOutput":{ "type":"structure", "required":["RevenueAttributionAllocationSummaries"], "members":{ "RevenueAttributionAllocationSummaries":{ "shape":"RevenueAttributionAllocationSummaryList", "documentation":"

Paginated list of allocations matching filters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for next page. Absent if no more results.

" } } }, "ListRevenueAttributionsInput":{ "type":"structure", "required":["Catalog"], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog to list revenue attributions from.

" }, "Identifiers":{ "shape":"RevenueAttributionIdentifierList", "documentation":"

Filter results to only include revenue attributions with the specified identifiers.

" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"

Filter results to only include revenue attributions created after this timestamp.

" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"

Filter results to only include revenue attributions created before this timestamp.

" }, "SortBy":{ "shape":"AttributionSortBy", "documentation":"

The field to sort revenue attributions by.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The direction to sort results.

" }, "MaxResults":{ "shape":"ListRevenueAttributionsInputMaxResultsInteger", "documentation":"

The maximum number of results to return in a single call.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for pagination. Use the value returned in the previous response to retrieve the next page.

" } } }, "ListRevenueAttributionsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListRevenueAttributionsOutput":{ "type":"structure", "members":{ "RevenueAttributionSummaries":{ "shape":"RevenueAttributionSummaries", "documentation":"

The list of revenue attribution summaries.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token for pagination. Present if there are more results available.

" } } }, "ListTagsForResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource to list tags for.

" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "tags":{ "shape":"TagList", "documentation":"

The tags associated with the resource.

" } } }, "MarketplaceProductId":{ "type":"string", "max":18, "min":18, "pattern":"prod-[a-z0-9]{13}" }, "MarketplaceProductIdList":{ "type":"list", "member":{"shape":"MarketplaceProductId"}, "max":10, "min":1 }, "MarketplaceProductSummary":{ "type":"structure", "members":{ "ProductId":{ "shape":"MarketplaceProductSummaryProductIdString", "documentation":"

The product identifier provided at attribution creation.

" }, "ProductCode":{ "shape":"String", "documentation":"

The AWS Marketplace product code resolved using the product identifier.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" } }, "documentation":"

Read-time AWS Marketplace product attributes returned in revenue attribution responses, including service-resolved fields.

" }, "MarketplaceProductSummaryProductIdString":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-:/.]+" }, "MarketplaceRevenueShareAllocationId":{ "type":"string", "max":18, "min":18, "pattern":"mrsa-[A-Za-z0-9]{13}" }, "MarketplaceRevenueShareAllocationSortField":{ "type":"string", "enum":["EffectiveFrom"] }, "MarketplaceRevenueShareAllocationSummary":{ "type":"structure", "required":[ "MarketplaceRevenueShareAllocationId", "ProductId", "Arn", "EffectiveFrom", "RevenueSharePercent", "Status" ], "members":{ "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The unique identifier of the allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the parent marketplace revenue share.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date of the allocation.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date of the allocation, or null if open-ended.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The revenue share percentage.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

The status of the allocation.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was last modified.

" } }, "documentation":"

Summary information about a marketplace revenue share allocation.

" }, "MarketplaceRevenueShareAllocationSummaryList":{ "type":"list", "member":{"shape":"MarketplaceRevenueShareAllocationSummary"} }, "MarketplaceRevenueShareSortBy":{ "type":"string", "enum":["LastModifiedDate"] }, "MarketplaceRevenueShareSummary":{ "type":"structure", "required":[ "ProductId", "Arn" ], "members":{ "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the marketplace revenue share.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the marketplace revenue share belongs to.

" }, "ProductCode":{ "shape":"String", "documentation":"

The AWS Marketplace product code.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the marketplace revenue share was last modified.

" }, "LatestRevision":{ "shape":"Integer", "documentation":"

The latest revision number of the marketplace revenue share.

" }, "TotalActiveMarketplaceRevenueShareAllocationCount":{ "shape":"Integer", "documentation":"

The number of active allocations under this share.

" }, "TotalMarketplaceRevenueShareAllocationCount":{ "shape":"Integer", "documentation":"

The total number of allocations under this share.

" } }, "documentation":"

Summary information about a marketplace revenue share.

" }, "MarketplaceRevenueShareSummaryList":{ "type":"list", "member":{"shape":"MarketplaceRevenueShareSummary"} }, "MarketplaceRevenueShareTagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "NextToken":{ "type":"string", "max":2048, "min":1, "pattern":"[\\S]+" }, "ProductCodeList":{ "type":"list", "member":{"shape":"String"}, "max":10, "min":1 }, "ResourceARN":{ "type":"string", "max":1011, "min":1, "pattern":"arn:aws:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/(revenue-attribution/[a-zA-Z0-9-]+|marketplace-revenue-share/prod-[a-z0-9]{13})" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{"shape":"String"}, "Reason":{ "shape":"ResourceNotFoundExceptionReason", "documentation":"

The reason the resource was not found.

" } }, "documentation":"

The specified resource was not found.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceNotFoundExceptionReason":{ "type":"string", "enum":["RESOURCE_NOT_FOUND"] }, "RevenueAttributionAllocationAction":{ "type":"string", "enum":[ "CREATE", "UPDATE" ] }, "RevenueAttributionAllocationErrorCode":{ "type":"string", "enum":[ "ALLOCATION_CAP_EXCEEDED", "RESOURCE_NOT_FOUND", "IMMUTABLE_ALLOCATION", "ACCESS_DENIED", "INVALID_VALUE", "CONCURRENT_MODIFICATION", "INTERNAL_ERROR" ] }, "RevenueAttributionAllocationErrorDetail":{ "type":"structure", "required":[ "EntityType", "EntityId", "CustomerAwsAccountId", "EffectiveFrom", "EffectiveUntil", "Action", "ErrorCode", "ErrorMessage" ], "members":{ "RevenueAttributionAllocationId":{ "shape":"RevenueAttributionAllocationId", "documentation":"

The allocation identifier. Present for UPDATE actions; absent for CREATE actions.

" }, "EntityType":{ "shape":"EntityType", "documentation":"

The deal entity type of the failing record.

" }, "EntityId":{ "shape":"EntityIdentifier", "documentation":"

The deal entity identifier of the failing record.

" }, "CustomerAwsAccountId":{ "shape":"CustomerAwsAccountId", "documentation":"

The customer AWS account ID of the failing record.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

Effective start date of the failing record.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

Effective end date of the failing record.

" }, "Action":{ "shape":"RevenueAttributionAllocationAction", "documentation":"

The action that was attempted.

" }, "ErrorCode":{ "shape":"RevenueAttributionAllocationErrorCode", "documentation":"

Machine-readable error code.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

Human-readable error description.

" } }, "documentation":"

Details of a validation error for a single revenue attribution allocation record.

" }, "RevenueAttributionAllocationErrorDetailList":{ "type":"list", "member":{"shape":"RevenueAttributionAllocationErrorDetail"} }, "RevenueAttributionAllocationId":{ "type":"string", "max":19, "min":19, "pattern":"alloc-[a-z0-9]{13}" }, "RevenueAttributionAllocationSortField":{ "type":"string", "enum":["EffectiveFrom"] }, "RevenueAttributionAllocationSummary":{ "type":"structure", "required":[ "RevenueAttributionAllocationId", "RevenueAttributionIdentifier", "EntityType", "EntityIdentifier", "CustomerAwsAccountId", "RevenueSharePercent", "EffectiveFrom", "EffectiveUntil", "Status" ], "members":{ "RevenueAttributionAllocationId":{ "shape":"RevenueAttributionAllocationId", "documentation":"

Unique allocation identifier.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier.

" }, "EntityType":{ "shape":"EntityType", "documentation":"

The type of the associated deal entity.

" }, "EntityIdentifier":{ "shape":"EntityIdentifier", "documentation":"

The unique identifier of the associated deal entity.

" }, "EntityName":{ "shape":"String", "documentation":"

The display name of the associated deal entity.

" }, "CustomerAwsAccountId":{ "shape":"CustomerAwsAccountId", "documentation":"

The customer AWS account ID for this associated deal entity.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

Revenue share percentage.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

First day of the effective month.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

Last day of the effective month.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

Current allocation status.

" } }, "documentation":"

Summary information about a revenue attribution allocation.

" }, "RevenueAttributionAllocationSummaryList":{ "type":"list", "member":{"shape":"RevenueAttributionAllocationSummary"} }, "RevenueAttributionAllocationTaskId":{ "type":"string", "max":21, "min":21, "pattern":"raatask-[a-z0-9]{13}" }, "RevenueAttributionAllocationTaskStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "COMPLETE", "FAILED" ] }, "RevenueAttributionId":{ "type":"string", "max":1011, "min":16, "pattern":"(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/revenue-attribution/ra-[a-z0-9]{13}|ra-[a-z0-9]{13})" }, "RevenueAttributionIdentifier":{ "type":"string", "max":1011, "min":16, "pattern":"(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/revenue-attribution/ra-[a-z0-9]{13}|ra-[a-z0-9]{13})" }, "RevenueAttributionIdentifierList":{ "type":"list", "member":{"shape":"RevenueAttributionIdentifier"}, "max":100, "min":1 }, "RevenueAttributionSummaries":{ "type":"list", "member":{"shape":"AttributionSummary"} }, "RevenueShareAllocation":{ "type":"structure", "required":[ "Action", "EntityType", "EntityIdentifier", "CustomerAwsAccountId", "RevenueSharePercent", "EffectiveFrom", "EffectiveUntil" ], "members":{ "Action":{ "shape":"RevenueAttributionAllocationAction", "documentation":"

The operation type: CREATE or UPDATE.

" }, "RevenueAttributionAllocationId":{ "shape":"RevenueAttributionAllocationId", "documentation":"

The allocation to update. Required when Action is UPDATE.

" }, "EntityType":{ "shape":"EntityType", "documentation":"

The type of the associated deal entity.

" }, "EntityIdentifier":{ "shape":"EntityIdentifier", "documentation":"

The unique identifier of the associated deal entity.

" }, "CustomerAwsAccountId":{ "shape":"CustomerAwsAccountId", "documentation":"

The customer AWS account ID for this associated deal entity.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

Revenue share percentage.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date for this allocation.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date for this allocation.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

Allocation status. Defaults to ACTIVE on CREATE.

" } }, "documentation":"

A single allocation change within a batch request.

" }, "RevenueShareAllocationChangeList":{ "type":"list", "member":{"shape":"RevenueShareAllocation"}, "max":250, "min":1 }, "RevenueSharePercent":{ "type":"string", "max":6, "min":1, "pattern":"\\d{1,3}(\\.\\d{1,2})?" }, "RevisionToken":{ "type":"string", "max":19, "min":1, "pattern":"[1-9][0-9]*" }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{"shape":"String"}, "Reason":{ "shape":"ServiceQuotaExceededExceptionReason", "documentation":"

The reason the service quota was exceeded.

" } }, "documentation":"

The request would exceed a service quota limit.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "ServiceQuotaExceededExceptionReason":{ "type":"string", "enum":[ "ATTRIBUTION_LIMIT_EXCEEDED", "TAG_LIMIT_EXCEEDED" ] }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "StartRevenueAttributionAllocationsTaskInput":{ "type":"structure", "required":[ "Catalog", "RevenueAttributionIdentifier", "RevenueAttributionRevision", "RevenueShareAllocations" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog context for this operation.

" }, "RevenueAttributionIdentifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The revenue attribution identifier.

" }, "RevenueAttributionRevision":{ "shape":"RevisionToken", "documentation":"

Current revision of the revenue attribution for optimistic locking.

" }, "RevenueShareAllocations":{ "shape":"RevenueShareAllocationChangeList", "documentation":"

The list of allocation changes to process in this batch.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

Idempotency token for deduplication and retry.

", "idempotencyToken":true }, "Description":{ "shape":"StartRevenueAttributionAllocationsTaskInputDescriptionString", "documentation":"

Human-readable description of the batch.

" } } }, "StartRevenueAttributionAllocationsTaskInputDescriptionString":{ "type":"string", "max":1024, "min":0, "pattern":"[\\x20-\\x7E]*" }, "StartRevenueAttributionAllocationsTaskOutput":{ "type":"structure", "required":[ "TaskId", "Status", "Catalog", "RevenueAttributionArn", "StartedAt", "TotalRevenueAttributionAllocationRecords" ], "members":{ "TaskId":{ "shape":"RevenueAttributionAllocationTaskId", "documentation":"

Unique identifier for the submitted task.

" }, "Status":{ "shape":"RevenueAttributionAllocationTaskStatus", "documentation":"

Initial task status. Always IN_PROGRESS on successful submission.

" }, "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog used for this task.

" }, "RevenueAttributionArn":{ "shape":"String", "documentation":"

ARN of the revenue attribution resource.

" }, "StartedAt":{ "shape":"Timestamp", "documentation":"

When processing started.

" }, "TotalRevenueAttributionAllocationRecords":{ "shape":"Integer", "documentation":"

Total revenue attribution allocation records in the batch.

" } } }, "String":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key portion of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value portion of the tag.

" } }, "documentation":"

A key-value pair used for organizing and managing resources through metadata tags.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"[^\\x00-\\x1F\\x7F]+" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":1 }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource to tag.

" }, "tags":{ "shape":"TagList", "documentation":"

The tags to add to the resource.

" } } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"[^\\x00-\\x1F\\x7F]*" }, "TenancyModel":{ "type":"string", "enum":[ "MULTI_TENANT", "SINGLE_TENANT" ] }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"}, "ServiceCode":{ "shape":"String", "documentation":"

The service code associated with the throttling error.

" }, "QuotaCode":{ "shape":"String", "documentation":"

The quota code associated with the throttling error.

" } }, "documentation":"

The request was throttled due to too many requests. Retry your request.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "Timestamp":{"type":"timestamp"}, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource to remove tags from.

" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys to remove from the resource.

" } } }, "UpdateMarketplaceRevenueShareAllocationInput":{ "type":"structure", "required":[ "Catalog", "ProductId", "MarketplaceRevenueShareAllocationId", "MarketplaceRevenueShareRevision" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog containing the allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier for the parent revenue share.

" }, "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The identifier of the allocation to update.

" }, "MarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

The current revision of the parent share. Must match for optimistic concurrency control.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique token to ensure idempotency of the update request.

", "idempotencyToken":true }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The new effective start date. Must be the first day of a month. Only modifiable on future-dated allocations.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The new effective end date. Must be the last day of a month and on or after today.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The new revenue share percentage. Only modifiable on future-dated allocations.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

The new status. Set to INACTIVE for soft-delete. Only modifiable on future-dated allocations.

" } } }, "UpdateMarketplaceRevenueShareAllocationOutput":{ "type":"structure", "required":[ "MarketplaceRevenueShareAllocationId", "ProductId", "Arn", "EffectiveFrom", "RevenueSharePercent", "Status" ], "members":{ "MarketplaceRevenueShareAllocationId":{ "shape":"MarketplaceRevenueShareAllocationId", "documentation":"

The unique identifier of the updated allocation.

" }, "ProductId":{ "shape":"MarketplaceProductId", "documentation":"

The AWS Marketplace product identifier.

" }, "ProductName":{ "shape":"String", "documentation":"

The display name of the AWS Marketplace product.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the parent marketplace revenue share.

" }, "EffectiveFrom":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective start date of the allocation.

" }, "EffectiveUntil":{ "shape":"AllocationEffectiveDateString", "documentation":"

The effective end date of the allocation, or null if open-ended.

" }, "RevenueSharePercent":{ "shape":"RevenueSharePercent", "documentation":"

The revenue share percentage.

" }, "Status":{ "shape":"AllocationStatus", "documentation":"

The status of the allocation.

" }, "CreatedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was created.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the allocation was last modified.

" }, "LatestMarketplaceRevenueShareRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the parent marketplace revenue share after the update.

" } } }, "UpdateRevenueAttributionInput":{ "type":"structure", "required":[ "Catalog", "Identifier", "Revision" ], "members":{ "Catalog":{ "shape":"CatalogName", "documentation":"

The catalog that the revenue attribution belongs to.

" }, "Identifier":{ "shape":"RevenueAttributionIdentifier", "documentation":"

The unique identifier of the revenue attribution to update. Accepts a direct ID or ARN.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique token to ensure idempotency of the update request.

", "idempotencyToken":true }, "Description":{ "shape":"UpdateRevenueAttributionInputDescriptionString", "documentation":"

The updated description of the revenue attribution.

" }, "Revision":{ "shape":"RevisionToken", "documentation":"

The current revision of the revenue attribution. Must match the server's current value.

" } } }, "UpdateRevenueAttributionInputDescriptionString":{ "type":"string", "max":1024, "min":0, "pattern":"[\\x20-\\x7E]*" }, "UpdateRevenueAttributionOutput":{ "type":"structure", "required":[ "Id", "Arn", "LastModifiedDate" ], "members":{ "Id":{ "shape":"RevenueAttributionId", "documentation":"

The unique identifier of the updated revenue attribution.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the updated revenue attribution.

" }, "Description":{ "shape":"String", "documentation":"

The updated description of the revenue attribution.

" }, "LastModifiedDate":{ "shape":"Timestamp", "documentation":"

The date when the attribution was last modified.

" }, "LatestRevision":{ "shape":"RevisionToken", "documentation":"

The latest revision of the attribution after the update.

" } } }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason" ], "members":{ "Message":{"shape":"String"}, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"

The reason for the validation failure.

" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

A list of fields that failed validation.

" } }, "documentation":"

The request failed validation due to invalid input parameters.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message", "Code" ], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the field that failed validation.

" }, "Message":{ "shape":"String", "documentation":"

A human-readable message describing why the field validation failed.

" }, "Code":{ "shape":"FieldValidationCode", "documentation":"

The specific validation error code indicating the type of validation failure.

" } }, "documentation":"

Details about a specific field that failed validation.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "REQUEST_VALIDATION_FAILED", "BUSINESS_VALIDATION_FAILED" ] } }, "documentation":"

AWS Partner Central Revenue Measurement API for creating, managing, and tracking revenue attributions and their allocations with deal entities such as offers and opportunities.

" }