Partner Central Revenue Measurement API

2026/11/19 - Partner Central Revenue Measurement API - 1 new 11 updated api methods

Changes  Marketplace revenue shares are now identified by a marketplace revenue share ID. Adds the UpdateMarketplaceRevenueShare API, optional grouping of AWS Marketplace products that run on the same backend AWS infrastructure, and context attributes for revenue attributions.

UpdateMarketplaceRevenueShare (new) Link ¶

Replaces the products of a marketplace revenue share. The request carries the complete desired set of products and their typed account lists; a product not listed is removed and its account lists cleared, and an empty Products list closes the marketplace revenue share. Closing is one-way.

See also: AWS API Documentation

Request Syntax

client.update_marketplace_revenue_share(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    ClientToken='string',
    Revision='string',
    Products=[
        {
            'ProductId': 'string',
            'Accounts': [
                {
                    'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                    'AccountIds': [
                        'string',
                    ]
                },
            ]
        },
    ]
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the marketplace revenue share belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

The marketplace revenue share to update, by ID (mrs-...) or ARN.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the update request.

This field is autopopulated if not provided.

type Revision:

string

param Revision:

[REQUIRED]

The current revision of the marketplace revenue share, for optimistic concurrency control. A stale value returns ConflictException with Reason REVISION_MISMATCH.

type Products:

list

param Products:

[REQUIRED]

The complete desired set of products in the marketplace revenue share, each with its typed account lists. 0 to 25 products; an empty list closes the marketplace revenue share.

  • (dict) --

    A product and its typed account lists as supplied in a CreateMarketplaceRevenueShare or UpdateMarketplaceRevenueShare request.

    • ProductId (string) -- [REQUIRED]

      The AWS Marketplace product ID or product ARN. The share stores and returns the product ID.

    • Accounts (list) --

      The typed account lists for this product. Omit to have the service determine the accounts. At most one entry per type; each entry must carry at least one account. An empty list is the same as omitting the field.

      • (dict) --

        A typed account list supplied for a product in a CreateMarketplaceRevenueShare or UpdateMarketplaceRevenueShare request.

        • AccountType (string) -- [REQUIRED]

          The type of account list.

        • AccountIds (list) -- [REQUIRED]

          The AWS account identifiers for this type. Each ID must be a 12-digit AWS account ID. Account ownership is verified after the request is accepted.

          • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Products': [
        {
            'ProductId': 'string',
            'ProductCode': 'string',
            'ProductName': 'string',
            'Accounts': [
                {
                    'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                    'Count': 123
                },
            ]
        },
    ],
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestRevision': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the updated marketplace revenue share, short ID form (mrs-...).

    • Arn (string) --

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

    • Products (list) --

      The products in the marketplace revenue share after the update, each with per-type account counts. Empty when the marketplace revenue share is closed.

      • (dict) --

        A product in a marketplace revenue share, as returned in Create, Update and List responses, with per-type account counts but no account IDs.

        • ProductId (string) --

          The AWS Marketplace product identifier.

        • ProductCode (string) --

          The AWS Marketplace product code, resolved by the service.

        • ProductName (string) --

          The display name of the AWS Marketplace product, resolved by the service.

        • Accounts (list) --

          Per-type counts of the accounts associated with this product.

          • (dict) --

            A per-type count of accounts associated with a product.

            • AccountType (string) --

              The type of account list.

            • Count (integer) --

              The number of accounts of this type.

    • LastModifiedDate (datetime) --

      The date when the marketplace revenue share was last modified.

    • LatestRevision (string) --

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

CreateMarketplaceRevenueShare (updated) Link ¶
Changes (request, response)
Request
{'Products': [{'Accounts': [{'AccountIds': ['string'],
                             'AccountType': 'DEPLOYMENT | ORGANIZATION'}],
               'ProductId': 'string'}]}
Response
{'Id': 'string',
 'Products': [{'Accounts': [{'AccountType': 'DEPLOYMENT | ORGANIZATION',
                             'Count': 'integer'}],
               'ProductCode': 'string',
               'ProductId': 'string',
               'ProductName': 'string'}]}

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

See also: AWS API Documentation

Request Syntax

client.create_marketplace_revenue_share(
    Catalog='AWS'|'Sandbox',
    ClientToken='string',
    Products=[
        {
            'ProductId': 'string',
            'Accounts': [
                {
                    'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                    'AccountIds': [
                        'string',
                    ]
                },
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the marketplace revenue share.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type Products:

list

param Products:

[REQUIRED]

The products in the marketplace revenue share, each with its typed account lists. 1 to 25 products.

  • (dict) --

    A product and its typed account lists as supplied in a CreateMarketplaceRevenueShare or UpdateMarketplaceRevenueShare request.

    • ProductId (string) -- [REQUIRED]

      The AWS Marketplace product ID or product ARN. The share stores and returns the product ID.

    • Accounts (list) --

      The typed account lists for this product. Omit to have the service determine the accounts. At most one entry per type; each entry must carry at least one account. An empty list is the same as omitting the field.

      • (dict) --

        A typed account list supplied for a product in a CreateMarketplaceRevenueShare or UpdateMarketplaceRevenueShare request.

        • AccountType (string) -- [REQUIRED]

          The type of account list.

        • AccountIds (list) -- [REQUIRED]

          The AWS account identifiers for this type. Each ID must be a 12-digit AWS account ID. Account ownership is verified after the request is accepted.

          • (string) --

type Tags:

list

param Tags:

Tags to associate with the marketplace revenue share upon creation.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The key portion of the tag.

    • Value (string) -- [REQUIRED]

      The value portion of the tag.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'Products': [
        {
            'ProductId': 'string',
            'ProductCode': 'string',
            'ProductName': 'string',
            'Accounts': [
                {
                    'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                    'Count': 123
                },
            ]
        },
    ],
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the newly created marketplace revenue share, short ID form (mrs-...).

    • Arn (string) --

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

    • Catalog (string) --

      The catalog that the marketplace revenue share belongs to.

    • Products (list) --

      The products in the newly created marketplace revenue share, each with per-type account counts.

      • (dict) --

        A product in a marketplace revenue share, as returned in Create, Update and List responses, with per-type account counts but no account IDs.

        • ProductId (string) --

          The AWS Marketplace product identifier.

        • ProductCode (string) --

          The AWS Marketplace product code, resolved by the service.

        • ProductName (string) --

          The display name of the AWS Marketplace product, resolved by the service.

        • Accounts (list) --

          Per-type counts of the accounts associated with this product.

          • (dict) --

            A per-type count of accounts associated with a product.

            • AccountType (string) --

              The type of account list.

            • Count (integer) --

              The number of accounts of this type.

    • CreatedDate (datetime) --

      The date when the marketplace revenue share was created.

    • LastModifiedDate (datetime) --

      The date when the marketplace revenue share was last modified.

    • Revision (string) --

      The revision of the newly created marketplace revenue share.

CreateMarketplaceRevenueShareAllocation (updated) Link ¶
Changes (request, response)
Request
{'MarketplaceRevenueShareIdentifier': 'string',
 'MarketplaceRevenueShareRevision': 'string'}
Response
{'MarketplaceRevenueShareIdentifier': 'string',
 'MarketplaceRevenueShareLatestRevision': 'string',
 'MarketplaceRevenueShareRevision': 'string'}

Creates a new allocation under the specified marketplace revenue share.

See also: AWS API Documentation

Request Syntax

client.create_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    MarketplaceRevenueShareIdentifier='string',
    ClientToken='string',
    MarketplaceRevenueShareRevision='string',
    EffectiveFrom='string',
    EffectiveUntil='string',
    RevenueSharePercent='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the allocation.

type MarketplaceRevenueShareIdentifier:

string

param MarketplaceRevenueShareIdentifier:

[REQUIRED]

The parent marketplace revenue share, by ID (mrs-...) or ARN.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

[REQUIRED]

The revision of the parent marketplace revenue share that the caller last read, for optimistic concurrency control. A stale value returns ConflictException with Reason REVISION_MISMATCH.

type EffectiveFrom:

string

param EffectiveFrom:

[REQUIRED]

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

type EffectiveUntil:

string

param EffectiveUntil:

[REQUIRED]

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

type RevenueSharePercent:

string

param RevenueSharePercent:

[REQUIRED]

The revenue share percentage for this allocation.

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'MarketplaceRevenueShareIdentifier': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'MarketplaceRevenueShareRevision': 'string',
    'MarketplaceRevenueShareLatestRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the newly created allocation.

    • MarketplaceRevenueShareIdentifier (string) --

      The parent marketplace revenue share, short ID form (mrs-...).

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

      The effective end date of the allocation.

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • MarketplaceRevenueShareRevision (string) --

      The revision of the parent marketplace revenue share at which the allocation was created.

    • MarketplaceRevenueShareLatestRevision (string) --

      The latest revision of the parent marketplace revenue share.

CreateRevenueAttribution (updated) Link ¶
Changes (both)
{'Context': {'string': 'string'}}

Creates a new revenue attribution record in the specified catalog.

See also: AWS API Documentation

Request Syntax

client.create_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    ClientToken='string',
    Name='string',
    Description='string',
    TenancyModel='MULTI_TENANT'|'SINGLE_TENANT',
    ProductIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Context={
        'string': 'string'
    }
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the revenue attribution.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type Name:

string

param Name:

[REQUIRED]

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

type Description:

string

param Description:

A description of the revenue attribution.

type TenancyModel:

string

param TenancyModel:

[REQUIRED]

The tenancy model for this revenue attribution.

type ProductIdentifier:

string

param ProductIdentifier:

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

type Tags:

list

param Tags:

Tags to associate with the revenue attribution upon creation.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The key portion of the tag.

    • Value (string) -- [REQUIRED]

      The value portion of the tag.

type Context:

dict

param Context:

Program-defined key-value attributes for the revenue attribution.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
    'MarketplaceProduct': {
        'ProductId': 'string',
        'ProductCode': 'string',
        'ProductName': 'string'
    },
    'Revision': 'string',
    'Context': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the newly created revenue attribution.

    • Arn (string) --

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

    • Name (string) --

      The name of the revenue attribution.

    • Description (string) --

      The description of the revenue attribution.

    • TenancyModel (string) --

      The tenancy model for this revenue attribution.

    • MarketplaceProduct (dict) --

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

      • ProductId (string) --

        The product identifier provided at attribution creation.

      • ProductCode (string) --

        The AWS Marketplace product code resolved using the product identifier.

      • ProductName (string) --

        The display name of the AWS Marketplace product.

    • Revision (string) --

      The revision of the newly created attribution resource.

    • Context (dict) --

      Program-defined key-value attributes for the revenue attribution.

      • (string) --

        • (string) --

GetMarketplaceRevenueShare (updated) Link ¶
Changes (request, response)
Request
{'Identifier': 'string'}
Response
{'EffectiveFrom': 'string',
 'EffectiveUntil': 'string',
 'Id': 'string',
 'Products': [{'Accounts': [{'AccountIds': ['string'],
                             'AccountType': 'DEPLOYMENT | ORGANIZATION',
                             'Count': 'integer'}],
               'ProductCode': 'string',
               'ProductId': 'string',
               'ProductName': 'string'}]}

Retrieves the details of a specific marketplace revenue share.

See also: AWS API Documentation

Request Syntax

client.get_marketplace_revenue_share(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    Revision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the marketplace revenue share belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

The marketplace revenue share to retrieve, by ID (mrs-...) or ARN.

type Revision:

string

param Revision:

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

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'Products': [
        {
            'ProductId': 'string',
            'ProductCode': 'string',
            'ProductName': 'string',
            'Accounts': [
                {
                    'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                    'Count': 123,
                    'AccountIds': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 'string',
    'LatestRevision': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'TotalActiveMarketplaceRevenueShareAllocationCount': 123,
    'TotalMarketplaceRevenueShareAllocationCount': 123
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the marketplace revenue share, short ID form (mrs-...).

    • Arn (string) --

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

    • Catalog (string) --

      The catalog that the marketplace revenue share belongs to.

    • Products (list) --

      The products in the marketplace revenue share, each with its typed account lists and full account IDs. Empty when the share is closed.

      • (dict) --

        A product in a marketplace revenue share, as returned by GetMarketplaceRevenueShare, with the full typed account lists.

        • ProductId (string) --

          The AWS Marketplace product identifier.

        • ProductCode (string) --

          The AWS Marketplace product code, resolved by the service.

        • ProductName (string) --

          The display name of the AWS Marketplace product, resolved by the service.

        • Accounts (list) --

          The typed account lists for this product, each with its count and full list of IDs.

          • (dict) --

            A typed account list returned by GetMarketplaceRevenueShare, with its count and full list of IDs.

            • AccountType (string) --

              The type of account list.

            • Count (integer) --

              The number of accounts of this type.

            • AccountIds (list) --

              The full list of AWS account identifiers of this type.

              • (string) --

    • CreatedDate (datetime) --

      The date when the marketplace revenue share was created.

    • LastModifiedDate (datetime) --

      The date when the marketplace revenue share was last modified.

    • Revision (string) --

      The revision of the retrieved marketplace revenue share.

    • LatestRevision (string) --

      The latest revision of the marketplace revenue share.

    • EffectiveFrom (string) --

      The date from which this share is effective, derived from the earliest ACTIVE allocation start date (YYYY-MM-DD). Absent when no ACTIVE allocation remains.

    • EffectiveUntil (string) --

      The date until which this share is effective, derived from the latest ACTIVE allocation end date (YYYY-MM-DD). Absent when no ACTIVE allocation remains.

    • TotalActiveMarketplaceRevenueShareAllocationCount (integer) --

      The number of active allocations under this marketplace revenue share.

    • TotalMarketplaceRevenueShareAllocationCount (integer) --

      The total number of allocations under this marketplace revenue share.

GetMarketplaceRevenueShareAllocation (updated) Link ¶
Changes (request, response)
Request
{'MarketplaceRevenueShareIdentifier': 'string'}
Response
{'MarketplaceRevenueShareIdentifier': 'string',
 'MarketplaceRevenueShareLatestRevision': 'string',
 'MarketplaceRevenueShareRevision': 'string'}

Retrieves the details of a specific marketplace revenue share allocation.

See also: AWS API Documentation

Request Syntax

client.get_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    MarketplaceRevenueShareIdentifier='string',
    MarketplaceRevenueShareAllocationId='string',
    MarketplaceRevenueShareRevision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the allocation belongs to.

type MarketplaceRevenueShareIdentifier:

string

param MarketplaceRevenueShareIdentifier:

[REQUIRED]

The parent marketplace revenue share, by ID (mrs-...) or ARN.

type MarketplaceRevenueShareAllocationId:

string

param MarketplaceRevenueShareAllocationId:

[REQUIRED]

The unique identifier of the allocation to retrieve.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'MarketplaceRevenueShareIdentifier': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'MarketplaceRevenueShareRevision': 'string',
    'MarketplaceRevenueShareLatestRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the allocation.

    • MarketplaceRevenueShareIdentifier (string) --

      The parent marketplace revenue share, short ID form (mrs-...).

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

      The effective end date of the allocation.

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • MarketplaceRevenueShareRevision (string) --

      The revision of the parent marketplace revenue share at which the allocation was read.

    • MarketplaceRevenueShareLatestRevision (string) --

      The latest revision of the parent marketplace revenue share.

GetRevenueAttribution (updated) Link ¶
Changes (response)
{'Context': {'string': 'string'}}

Retrieves the details of a specific revenue attribution.

See also: AWS API Documentation

Request Syntax

client.get_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    Revision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the revenue attribution belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

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

type Revision:

string

param Revision:

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

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'Name': 'string',
    'Description': 'string',
    'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
    'MarketplaceProduct': {
        'ProductId': 'string',
        'ProductCode': 'string',
        'ProductName': 'string'
    },
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 'string',
    'LatestRevision': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'TotalActiveRevenueAttributionAllocationCount': 123,
    'TotalRevenueAttributionAllocationCount': 123,
    'Context': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Arn (string) --

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

    • Id (string) --

      The unique identifier of the revenue attribution.

    • Catalog (string) --

      The catalog that the revenue attribution belongs to.

    • Name (string) --

      The display name of the revenue attribution.

    • Description (string) --

      A description of the revenue attribution.

    • TenancyModel (string) --

      The tenancy model for this revenue attribution.

    • MarketplaceProduct (dict) --

      The associated AWS Marketplace product listing, if set.

      • ProductId (string) --

        The product identifier provided at attribution creation.

      • ProductCode (string) --

        The AWS Marketplace product code resolved using the product identifier.

      • ProductName (string) --

        The display name of the AWS Marketplace product.

    • CreatedDate (datetime) --

      The date when the revenue attribution was created.

    • LastModifiedDate (datetime) --

      The date when the revenue attribution was last modified.

    • Revision (string) --

      The revision of the retrieved attribution.

    • LatestRevision (string) --

      The latest revision of the attribution.

    • EffectiveFrom (string) --

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

    • EffectiveUntil (string) --

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

    • TotalActiveRevenueAttributionAllocationCount (integer) --

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

    • TotalRevenueAttributionAllocationCount (integer) --

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

    • Context (dict) --

      Program-defined key-value attributes for the revenue attribution.

      • (string) --

        • (string) --

ListMarketplaceRevenueShareAllocations (updated) Link ¶
Changes (request, response)
Request
{'AfterEffectiveUntil': 'string',
 'BeforeEffectiveUntil': 'string',
 'MarketplaceRevenueShareIdentifier': 'string',
 'StatusFilter': 'ACTIVE | INACTIVE'}
Response
{'MarketplaceRevenueShareAllocationSummaries': {'MarketplaceRevenueShareIdentifier': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.list_marketplace_revenue_share_allocations(
    Catalog='AWS'|'Sandbox',
    MarketplaceRevenueShareIdentifier='string',
    StatusFilter='ACTIVE'|'INACTIVE',
    AfterEffectiveFrom='string',
    BeforeEffectiveFrom='string',
    AfterEffectiveUntil='string',
    BeforeEffectiveUntil='string',
    SortBy='EffectiveFrom',
    SortOrder='ASCENDING'|'DESCENDING',
    MaxResults=123,
    NextToken='string',
    MarketplaceRevenueShareRevision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog containing the allocations.

type MarketplaceRevenueShareIdentifier:

string

param MarketplaceRevenueShareIdentifier:

[REQUIRED]

The parent marketplace revenue share, by ID (mrs-...) or ARN.

type StatusFilter:

string

param StatusFilter:

Filter by allocation status.

type AfterEffectiveFrom:

string

param AfterEffectiveFrom:

Inclusive lower bound for EffectiveFrom date filter.

type BeforeEffectiveFrom:

string

param BeforeEffectiveFrom:

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

type AfterEffectiveUntil:

string

param AfterEffectiveUntil:

Inclusive lower bound for EffectiveUntil date filter.

type BeforeEffectiveUntil:

string

param BeforeEffectiveUntil:

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

type SortBy:

string

param SortBy:

The field to sort marketplace revenue share allocations by.

type SortOrder:

string

param SortOrder:

The direction to sort results. Defaults to ASCENDING.

type MaxResults:

integer

param MaxResults:

Maximum number of results per page.

type NextToken:

string

param NextToken:

Pagination token from a previous response.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationSummaries': [
        {
            'MarketplaceRevenueShareAllocationId': 'string',
            'MarketplaceRevenueShareIdentifier': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'RevenueSharePercent': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationSummaries (list) --

      The list of allocation summaries for the current page.

      • (dict) --

        Summary information about a marketplace revenue share allocation.

        • MarketplaceRevenueShareAllocationId (string) --

          The unique identifier of the allocation.

        • MarketplaceRevenueShareIdentifier (string) --

          The parent marketplace revenue share, short ID form (mrs-...).

        • EffectiveFrom (string) --

          The effective start date of the allocation.

        • EffectiveUntil (string) --

          The effective end date of the allocation.

        • RevenueSharePercent (string) --

          The revenue share percentage.

        • Status (string) --

          The status of the allocation.

        • CreatedDate (datetime) --

          The date when the allocation was created.

        • LastModifiedDate (datetime) --

          The date when the allocation was last modified.

    • NextToken (string) --

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

ListMarketplaceRevenueShares (updated) Link ¶
Changes (request, response)
Request
{'Identifiers': ['string']}
Response
{'MarketplaceRevenueShareSummaries': {'EffectiveFrom': 'string',
                                      'EffectiveUntil': 'string',
                                      'Id': 'string',
                                      'Products': [{'Accounts': [{'AccountType': 'DEPLOYMENT '
                                                                                 '| '
                                                                                 'ORGANIZATION',
                                                                  'Count': 'integer'}],
                                                    'ProductCode': 'string',
                                                    'ProductId': 'string',
                                                    'ProductName': 'string'}]}}

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

See also: AWS API Documentation

Request Syntax

client.list_marketplace_revenue_shares(
    Catalog='AWS'|'Sandbox',
    Identifiers=[
        'string',
    ],
    ProductIds=[
        'string',
    ],
    ProductCodes=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    SortBy='LastModifiedDate',
    SortOrder='ASCENDING'|'DESCENDING',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1)
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog to list marketplace revenue shares from.

type Identifiers:

list

param Identifiers:

Filter results to only include these marketplace revenue shares, by ID or ARN. 1 to 100 identifiers. When several filters are sent, a share must match all of them.

  • (string) --

type ProductIds:

list

param ProductIds:

Filter results to the marketplace revenue shares that contain any of these products. 1 to 10 product IDs or product ARNs. Shares the caller does not own are never returned.

  • (string) --

type ProductCodes:

list

param ProductCodes:

Filter results to the marketplace revenue shares that contain a product with any of these product codes. 1 to 10 product codes.

  • (string) --

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type SortBy:

string

param SortBy:

The field to sort marketplace revenue shares by.

type SortOrder:

string

param SortOrder:

The direction to sort results.

type CreatedAfter:

datetime

param CreatedAfter:

Filter results to marketplace revenue shares created at or after this timestamp (inclusive).

type CreatedBefore:

datetime

param CreatedBefore:

Filter results to marketplace revenue shares created before this timestamp (exclusive).

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareSummaries': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Catalog': 'AWS'|'Sandbox',
            'Products': [
                {
                    'ProductId': 'string',
                    'ProductCode': 'string',
                    'ProductName': 'string',
                    'Accounts': [
                        {
                            'AccountType': 'DEPLOYMENT'|'ORGANIZATION',
                            'Count': 123
                        },
                    ]
                },
            ],
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1),
            'LatestRevision': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'TotalActiveMarketplaceRevenueShareAllocationCount': 123,
            'TotalMarketplaceRevenueShareAllocationCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareSummaries (list) --

      The list of marketplace revenue share summaries.

      • (dict) --

        Summary information about a marketplace revenue share.

        • Id (string) --

          The unique identifier of the marketplace revenue share, short ID form (mrs-...).

        • Arn (string) --

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

        • Catalog (string) --

          The catalog that the marketplace revenue share belongs to.

        • Products (list) --

          The products in the marketplace revenue share, each with per-type account counts. Empty when the share is closed.

          • (dict) --

            A product in a marketplace revenue share, as returned in Create, Update and List responses, with per-type account counts but no account IDs.

            • ProductId (string) --

              The AWS Marketplace product identifier.

            • ProductCode (string) --

              The AWS Marketplace product code, resolved by the service.

            • ProductName (string) --

              The display name of the AWS Marketplace product, resolved by the service.

            • Accounts (list) --

              Per-type counts of the accounts associated with this product.

              • (dict) --

                A per-type count of accounts associated with a product.

                • AccountType (string) --

                  The type of account list.

                • Count (integer) --

                  The number of accounts of this type.

        • CreatedDate (datetime) --

          The date when the marketplace revenue share was created.

        • LastModifiedDate (datetime) --

          The date when the marketplace revenue share was last modified.

        • LatestRevision (string) --

          The latest revision of the marketplace revenue share.

        • EffectiveFrom (string) --

          The date from which this share is effective, derived from the earliest ACTIVE allocation start date (YYYY-MM-DD). Absent when no ACTIVE allocation remains.

        • EffectiveUntil (string) --

          The date until which this share is effective, derived from the latest ACTIVE allocation end date (YYYY-MM-DD). Absent when no ACTIVE allocation remains.

        • TotalActiveMarketplaceRevenueShareAllocationCount (integer) --

          The number of active allocations under this share.

        • TotalMarketplaceRevenueShareAllocationCount (integer) --

          The total number of allocations under this share.

    • NextToken (string) --

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

ListRevenueAttributions (updated) Link ¶
Changes (request, response)
Request
{'ContextFilters': [{'Key': 'string', 'Values': ['string']}]}
Response
{'RevenueAttributionSummaries': {'Context': {'string': 'string'}}}

Returns a paginated list of revenue attributions with optional filters.

See also: AWS API Documentation

Request Syntax

client.list_revenue_attributions(
    Catalog='AWS'|'Sandbox',
    Identifiers=[
        'string',
    ],
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='LastModifiedDate',
    SortOrder='ASCENDING'|'DESCENDING',
    MaxResults=123,
    NextToken='string',
    ContextFilters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog to list revenue attributions from.

type Identifiers:

list

param Identifiers:

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

  • (string) --

type CreatedAfter:

datetime

param CreatedAfter:

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

type CreatedBefore:

datetime

param CreatedBefore:

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

type SortBy:

string

param SortBy:

The field to sort revenue attributions by.

type SortOrder:

string

param SortOrder:

The direction to sort results.

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type ContextFilters:

list

param ContextFilters:

Filter results by context. Filters are combined with AND; values within a filter are combined with OR.

  • (dict) --

    Filters revenue attributions by a context key and, optionally, a set of values.

    • Key (string) -- [REQUIRED]

      The context key to filter on.

    • Values (list) --

      Matches when the stored value equals any of these values. When omitted, matches when the key is present.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'RevenueAttributionSummaries': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Catalog': 'AWS'|'Sandbox',
            'Name': 'string',
            'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
            'MarketplaceProduct': {
                'ProductId': 'string',
                'ProductCode': 'string',
                'ProductName': 'string'
            },
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1),
            'LatestRevision': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'TotalActiveRevenueAttributionAllocationCount': 123,
            'TotalRevenueAttributionAllocationCount': 123,
            'Context': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RevenueAttributionSummaries (list) --

      The list of revenue attribution summaries.

      • (dict) --

        Summary representation of a revenue attribution returned in list operations.

        • Arn (string) --

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

        • Id (string) --

          The unique identifier of the revenue attribution.

        • Catalog (string) --

          The catalog that the revenue attribution belongs to.

        • Name (string) --

          The display name of the revenue attribution.

        • TenancyModel (string) --

          The tenancy model for this revenue attribution.

        • MarketplaceProduct (dict) --

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

          • ProductId (string) --

            The product identifier provided at attribution creation.

          • ProductCode (string) --

            The AWS Marketplace product code resolved using the product identifier.

          • ProductName (string) --

            The display name of the AWS Marketplace product.

        • CreatedDate (datetime) --

          The date when the revenue attribution was created.

        • LastModifiedDate (datetime) --

          The date when the revenue attribution was last modified.

        • LatestRevision (string) --

          The latest revision of the revenue attribution resource.

        • EffectiveFrom (string) --

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

        • EffectiveUntil (string) --

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

        • TotalActiveRevenueAttributionAllocationCount (integer) --

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

        • TotalRevenueAttributionAllocationCount (integer) --

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

        • Context (dict) --

          Program-defined key-value attributes for the revenue attribution.

          • (string) --

            • (string) --

    • NextToken (string) --

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

UpdateMarketplaceRevenueShareAllocation (updated) Link ¶
Changes (request, response)
Request
{'MarketplaceRevenueShareIdentifier': 'string'}
Response
{'MarketplaceRevenueShareIdentifier': 'string',
 'MarketplaceRevenueShareLatestRevision': 'string',
 'MarketplaceRevenueShareRevision': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.update_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    MarketplaceRevenueShareIdentifier='string',
    MarketplaceRevenueShareAllocationId='string',
    MarketplaceRevenueShareRevision='string',
    ClientToken='string',
    RevenueSharePercent='string',
    Status='ACTIVE'|'INACTIVE'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog containing the allocation.

type MarketplaceRevenueShareIdentifier:

string

param MarketplaceRevenueShareIdentifier:

[REQUIRED]

The parent marketplace revenue share, by ID (mrs-...) or ARN.

type MarketplaceRevenueShareAllocationId:

string

param MarketplaceRevenueShareAllocationId:

[REQUIRED]

The identifier of the allocation to update.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the update request.

This field is autopopulated if not provided.

type RevenueSharePercent:

string

param RevenueSharePercent:

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

type Status:

string

param Status:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'MarketplaceRevenueShareIdentifier': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'MarketplaceRevenueShareRevision': 'string',
    'MarketplaceRevenueShareLatestRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the updated allocation.

    • MarketplaceRevenueShareIdentifier (string) --

      The parent marketplace revenue share, short ID form (mrs-...).

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

      The effective end date of the allocation.

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • MarketplaceRevenueShareRevision (string) --

      The revision of the parent marketplace revenue share at which the update was committed.

    • MarketplaceRevenueShareLatestRevision (string) --

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

UpdateRevenueAttribution (updated) Link ¶
Changes (both)
{'Context': {'string': 'string'}}

Updates an existing revenue attribution record.

See also: AWS API Documentation

Request Syntax

client.update_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    ClientToken='string',
    Description='string',
    Revision='string',
    Context={
        'string': 'string'
    }
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the revenue attribution belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the update request.

This field is autopopulated if not provided.

type Description:

string

param Description:

The updated description of the revenue attribution.

type Revision:

string

param Revision:

[REQUIRED]

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

type Context:

dict

param Context:

Full-replacement context map. Omit to leave the stored context unchanged; pass an empty map to clear it.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Description': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestRevision': 'string',
    'Context': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the updated revenue attribution.

    • Arn (string) --

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

    • Description (string) --

      The updated description of the revenue attribution.

    • LastModifiedDate (datetime) --

      The date when the attribution was last modified.

    • LatestRevision (string) --

      The latest revision of the attribution after the update.

    • Context (dict) --

      The context stored on the revenue attribution after the update.

      • (string) --

        • (string) --