PartnerCentralRevenueMeasurementAPIClient

Index > PartnerCentralRevenueMeasurementAPI > PartnerCentralRevenueMeasurementAPIClient

Auto-generated documentation for PartnerCentralRevenueMeasurementAPI type annotations stubs module mypy-boto3-partnercentral-revenue-measurement.

PartnerCentralRevenueMeasurementAPIClient

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement"). boto3 documentation

# PartnerCentralRevenueMeasurementAPIClient usage example

from boto3.session import Session
from mypy_boto3_partnercentral_revenue_measurement.client import PartnerCentralRevenueMeasurementAPIClient

def get_partnercentral-revenue-measurement_client() -> PartnerCentralRevenueMeasurementAPIClient:
    return Session().client("partnercentral-revenue-measurement")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("partnercentral-revenue-measurement").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("partnercentral-revenue-measurement")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_partnercentral_revenue_measurement.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_marketplace_revenue_share

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").create_marketplace_revenue_share method. boto3 documentation

# create_marketplace_revenue_share method definition

def create_marketplace_revenue_share(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMarketplaceRevenueShareOutputTypeDef:  # (3)
    ...

1. See CatalogNameType
2. See Sequence[TagTypeDef]
3. See CreateMarketplaceRevenueShareOutputTypeDef

# create_marketplace_revenue_share method usage example with argument unpacking

kwargs: CreateMarketplaceRevenueShareInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
}

parent.create_marketplace_revenue_share(**kwargs)

1. See CreateMarketplaceRevenueShareInputTypeDef

create_marketplace_revenue_share_allocation

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").create_marketplace_revenue_share_allocation method. boto3 documentation

# create_marketplace_revenue_share_allocation method definition

def create_marketplace_revenue_share_allocation(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    EffectiveFrom: str,
    RevenueSharePercent: str,
    ClientToken: str = ...,
    EffectiveUntil: str = ...,
) -> CreateMarketplaceRevenueShareAllocationOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See CreateMarketplaceRevenueShareAllocationOutputTypeDef

# create_marketplace_revenue_share_allocation method usage example with argument unpacking

kwargs: CreateMarketplaceRevenueShareAllocationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
    "EffectiveFrom": ...,
    "RevenueSharePercent": ...,
}

parent.create_marketplace_revenue_share_allocation(**kwargs)

1. See CreateMarketplaceRevenueShareAllocationInputTypeDef

create_revenue_attribution

Creates a new revenue attribution record in the specified catalog.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").create_revenue_attribution method. boto3 documentation

# create_revenue_attribution method definition

def create_revenue_attribution(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    Name: str,
    TenancyModel: TenancyModelType,  # (2)
    ClientToken: str = ...,
    Description: str = ...,
    ProductIdentifier: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRevenueAttributionOutputTypeDef:  # (4)
    ...

1. See CatalogNameType
2. See TenancyModelType
3. See Sequence[TagTypeDef]
4. See CreateRevenueAttributionOutputTypeDef

# create_revenue_attribution method usage example with argument unpacking

kwargs: CreateRevenueAttributionInputTypeDef = {  # (1)
    "Catalog": ...,
    "Name": ...,
    "TenancyModel": ...,
}

parent.create_revenue_attribution(**kwargs)

1. See CreateRevenueAttributionInputTypeDef

get_marketplace_revenue_share

Retrieves the details of a specific marketplace revenue share.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_marketplace_revenue_share method. boto3 documentation

# get_marketplace_revenue_share method definition

def get_marketplace_revenue_share(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    Revision: int = ...,
) -> GetMarketplaceRevenueShareOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See GetMarketplaceRevenueShareOutputTypeDef

# get_marketplace_revenue_share method usage example with argument unpacking

kwargs: GetMarketplaceRevenueShareInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
}

parent.get_marketplace_revenue_share(**kwargs)

1. See GetMarketplaceRevenueShareInputTypeDef

get_marketplace_revenue_share_allocation

Retrieves the details of a specific marketplace revenue share allocation.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_marketplace_revenue_share_allocation method. boto3 documentation

# get_marketplace_revenue_share_allocation method definition

def get_marketplace_revenue_share_allocation(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    MarketplaceRevenueShareAllocationId: str,
    MarketplaceRevenueShareRevision: str = ...,
) -> GetMarketplaceRevenueShareAllocationOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See GetMarketplaceRevenueShareAllocationOutputTypeDef

# get_marketplace_revenue_share_allocation method usage example with argument unpacking

kwargs: GetMarketplaceRevenueShareAllocationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
    "MarketplaceRevenueShareAllocationId": ...,
}

parent.get_marketplace_revenue_share_allocation(**kwargs)

1. See GetMarketplaceRevenueShareAllocationInputTypeDef

get_revenue_attribution

Retrieves the details of a specific revenue attribution.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_revenue_attribution method. boto3 documentation

# get_revenue_attribution method definition

def get_revenue_attribution(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    Identifier: str,
    Revision: str = ...,
) -> GetRevenueAttributionOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See GetRevenueAttributionOutputTypeDef

# get_revenue_attribution method usage example with argument unpacking

kwargs: GetRevenueAttributionInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
}

parent.get_revenue_attribution(**kwargs)

1. See GetRevenueAttributionInputTypeDef

get_revenue_attribution_allocation

Retrieves a single allocation by its RevenueAttributionAllocationId.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_revenue_attribution_allocation method. boto3 documentation

# get_revenue_attribution_allocation method definition

def get_revenue_attribution_allocation(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    RevenueAttributionIdentifier: str,
    RevenueAttributionAllocationId: str,
    RevenueAttributionRevision: str = ...,
) -> GetRevenueAttributionAllocationOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See GetRevenueAttributionAllocationOutputTypeDef

# get_revenue_attribution_allocation method usage example with argument unpacking

kwargs: GetRevenueAttributionAllocationInputTypeDef = {  # (1)
    "Catalog": ...,
    "RevenueAttributionIdentifier": ...,
    "RevenueAttributionAllocationId": ...,
}

parent.get_revenue_attribution_allocation(**kwargs)

1. See GetRevenueAttributionAllocationInputTypeDef

get_revenue_attribution_allocations_task

Retrieves the current status of a previously submitted allocations task.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_revenue_attribution_allocations_task method. boto3 documentation

# get_revenue_attribution_allocations_task method definition

def get_revenue_attribution_allocations_task(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    RevenueAttributionIdentifier: str,
) -> GetRevenueAttributionAllocationsTaskOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See GetRevenueAttributionAllocationsTaskOutputTypeDef

# get_revenue_attribution_allocations_task method usage example with argument unpacking

kwargs: GetRevenueAttributionAllocationsTaskInputTypeDef = {  # (1)
    "Catalog": ...,
    "RevenueAttributionIdentifier": ...,
}

parent.get_revenue_attribution_allocations_task(**kwargs)

1. See GetRevenueAttributionAllocationsTaskInputTypeDef

list_marketplace_revenue_share_allocations

Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").list_marketplace_revenue_share_allocations method. boto3 documentation

# list_marketplace_revenue_share_allocations method definition

def list_marketplace_revenue_share_allocations(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    Status: AllocationStatusType = ...,  # (2)
    AfterEffectiveFrom: str = ...,
    BeforeEffectiveFrom: str = ...,
    SortBy: MarketplaceRevenueShareAllocationSortFieldType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
    MaxResults: int = ...,
    NextToken: str = ...,
    MarketplaceRevenueShareRevision: str = ...,
) -> ListMarketplaceRevenueShareAllocationsOutputTypeDef:  # (5)
    ...

1. See CatalogNameType
2. See AllocationStatusType
3. See MarketplaceRevenueShareAllocationSortFieldType
4. See SortOrderType
5. See ListMarketplaceRevenueShareAllocationsOutputTypeDef

# list_marketplace_revenue_share_allocations method usage example with argument unpacking

kwargs: ListMarketplaceRevenueShareAllocationsInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
}

parent.list_marketplace_revenue_share_allocations(**kwargs)

1. See ListMarketplaceRevenueShareAllocationsInputTypeDef

list_marketplace_revenue_shares

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").list_marketplace_revenue_shares method. boto3 documentation

# list_marketplace_revenue_shares method definition

def list_marketplace_revenue_shares(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductIds: Sequence[str] = ...,
    ProductCodes: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: MarketplaceRevenueShareSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
) -> ListMarketplaceRevenueSharesOutputTypeDef:  # (4)
    ...

1. See CatalogNameType
2. See MarketplaceRevenueShareSortByType
3. See SortOrderType
4. See ListMarketplaceRevenueSharesOutputTypeDef

# list_marketplace_revenue_shares method usage example with argument unpacking

kwargs: ListMarketplaceRevenueSharesInputTypeDef = {  # (1)
    "Catalog": ...,
}

parent.list_marketplace_revenue_shares(**kwargs)

1. See ListMarketplaceRevenueSharesInputTypeDef

list_revenue_attribution_allocations

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").list_revenue_attribution_allocations method. boto3 documentation

# list_revenue_attribution_allocations method definition

def list_revenue_attribution_allocations(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    RevenueAttributionIdentifier: str,
    EntityTypeFilters: Sequence[EntityTypeType] = ...,  # (2)
    EntityIdentifierFilters: Sequence[str] = ...,
    CustomerAwsAccountIdFilters: Sequence[str] = ...,
    StatusFilter: AllocationStatusType = ...,  # (3)
    AfterEffectiveFrom: str = ...,
    BeforeEffectiveFrom: str = ...,
    AfterEffectiveUntil: str = ...,
    BeforeEffectiveUntil: str = ...,
    SortBy: RevenueAttributionAllocationSortFieldType = ...,  # (4)
    SortOrder: SortOrderType = ...,  # (5)
    RevenueAttributionRevision: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRevenueAttributionAllocationsOutputTypeDef:  # (6)
    ...

1. See CatalogNameType
2. See Sequence[EntityTypeType]
3. See AllocationStatusType
4. See RevenueAttributionAllocationSortFieldType
5. See SortOrderType
6. See ListRevenueAttributionAllocationsOutputTypeDef

# list_revenue_attribution_allocations method usage example with argument unpacking

kwargs: ListRevenueAttributionAllocationsInputTypeDef = {  # (1)
    "Catalog": ...,
    "RevenueAttributionIdentifier": ...,
}

parent.list_revenue_attribution_allocations(**kwargs)

1. See ListRevenueAttributionAllocationsInputTypeDef

list_revenue_attributions

Returns a paginated list of revenue attributions with optional filters.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").list_revenue_attributions method. boto3 documentation

# list_revenue_attributions method definition

def list_revenue_attributions(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    Identifiers: Sequence[str] = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: AttributionSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRevenueAttributionsOutputTypeDef:  # (4)
    ...

1. See CatalogNameType
2. See AttributionSortByType
3. See SortOrderType
4. See ListRevenueAttributionsOutputTypeDef

# list_revenue_attributions method usage example with argument unpacking

kwargs: ListRevenueAttributionsInputTypeDef = {  # (1)
    "Catalog": ...,
}

parent.list_revenue_attributions(**kwargs)

1. See ListRevenueAttributionsInputTypeDef

list_tags_for_resource

Returns the tags associated with the specified resource.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

start_revenue_attribution_allocations_task

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").start_revenue_attribution_allocations_task method. boto3 documentation

# start_revenue_attribution_allocations_task method definition

def start_revenue_attribution_allocations_task(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    RevenueAttributionIdentifier: str,
    RevenueAttributionRevision: str,
    RevenueShareAllocations: Sequence[RevenueShareAllocationTypeDef],  # (2)
    ClientToken: str = ...,
    Description: str = ...,
) -> StartRevenueAttributionAllocationsTaskOutputTypeDef:  # (3)
    ...

1. See CatalogNameType
2. See Sequence[RevenueShareAllocationTypeDef]
3. See StartRevenueAttributionAllocationsTaskOutputTypeDef

# start_revenue_attribution_allocations_task method usage example with argument unpacking

kwargs: StartRevenueAttributionAllocationsTaskInputTypeDef = {  # (1)
    "Catalog": ...,
    "RevenueAttributionIdentifier": ...,
    "RevenueAttributionRevision": ...,
    "RevenueShareAllocations": ...,
}

parent.start_revenue_attribution_allocations_task(**kwargs)

1. See StartRevenueAttributionAllocationsTaskInputTypeDef

tag_resource

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

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputTypeDef

untag_resource

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputTypeDef

update_marketplace_revenue_share_allocation

Updates an existing marketplace revenue share allocation.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").update_marketplace_revenue_share_allocation method. boto3 documentation

# update_marketplace_revenue_share_allocation method definition

def update_marketplace_revenue_share_allocation(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    ProductId: str,
    MarketplaceRevenueShareAllocationId: str,
    MarketplaceRevenueShareRevision: str,
    ClientToken: str = ...,
    EffectiveFrom: str = ...,
    EffectiveUntil: str = ...,
    RevenueSharePercent: str = ...,
    Status: AllocationStatusType = ...,  # (2)
) -> UpdateMarketplaceRevenueShareAllocationOutputTypeDef:  # (3)
    ...

1. See CatalogNameType
2. See AllocationStatusType
3. See UpdateMarketplaceRevenueShareAllocationOutputTypeDef

# update_marketplace_revenue_share_allocation method usage example with argument unpacking

kwargs: UpdateMarketplaceRevenueShareAllocationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ProductId": ...,
    "MarketplaceRevenueShareAllocationId": ...,
    "MarketplaceRevenueShareRevision": ...,
}

parent.update_marketplace_revenue_share_allocation(**kwargs)

1. See UpdateMarketplaceRevenueShareAllocationInputTypeDef

update_revenue_attribution

Updates an existing revenue attribution record.

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").update_revenue_attribution method. boto3 documentation

# update_revenue_attribution method definition

def update_revenue_attribution(
    self,
    *,
    Catalog: CatalogNameType,  # (1)
    Identifier: str,
    Revision: str,
    ClientToken: str = ...,
    Description: str = ...,
) -> UpdateRevenueAttributionOutputTypeDef:  # (2)
    ...

1. See CatalogNameType
2. See UpdateRevenueAttributionOutputTypeDef

# update_revenue_attribution method usage example with argument unpacking

kwargs: UpdateRevenueAttributionInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
    "Revision": ...,
}

parent.update_revenue_attribution(**kwargs)

1. See UpdateRevenueAttributionInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("partnercentral-revenue-measurement").get_paginator method with overloads.

• client.get_paginator("list_marketplace_revenue_share_allocations") -> ListMarketplaceRevenueShareAllocationsPaginator
• client.get_paginator("list_marketplace_revenue_shares") -> ListMarketplaceRevenueSharesPaginator
• client.get_paginator("list_revenue_attribution_allocations") -> ListRevenueAttributionAllocationsPaginator
• client.get_paginator("list_revenue_attributions") -> ListRevenueAttributionsPaginator