MarketplaceCommerceAnalyticsClient

Index > MarketplaceCommerceAnalytics > MarketplaceCommerceAnalyticsClient

Auto-generated documentation for MarketplaceCommerceAnalytics type annotations stubs module types-aiobotocore-marketplacecommerceanalytics.

MarketplaceCommerceAnalyticsClient

Type annotations and code completion for session.create_client("marketplacecommerceanalytics") boto3 documentation

MarketplaceCommerceAnalyticsClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_marketplacecommerceanalytics.client import MarketplaceCommerceAnalyticsClient

session = get_session()
async with session.create_client("marketplacecommerceanalytics") as client:
    client: MarketplaceCommerceAnalyticsClient

Exceptions

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("marketplacecommerceanalytics").exceptions structure.

MarketplaceCommerceAnalyticsClient.exceptions usage example

async with session.create_client("marketplacecommerceanalytics") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.MarketplaceCommerceAnalyticsException,
    ) as e:
        print(e)

MarketplaceCommerceAnalyticsClient usage type checking example

from types_aiobotocore_marketplacecommerceanalytics.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").can_paginate method. boto3 documentation

# can_paginate method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

generate_data_set

Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available.

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").generate_data_set method. boto3 documentation

# generate_data_set method definition

await def generate_data_set(
    self,
    *,
    dataSetType: DataSetTypeType,  # (1)
    dataSetPublicationDate: Union[datetime, str],
    roleNameArn: str,
    destinationS3BucketName: str,
    snsTopicArn: str,
    destinationS3Prefix: str = ...,
    customerDefinedValues: Mapping[str, str] = ...,
) -> GenerateDataSetResultTypeDef:  # (2)
    ...

1. See DataSetTypeType
2. See GenerateDataSetResultTypeDef

# generate_data_set method usage example with argument unpacking

kwargs: GenerateDataSetRequestRequestTypeDef = {  # (1)
    "dataSetType": ...,
    "dataSetPublicationDate": ...,
    "roleNameArn": ...,
    "destinationS3BucketName": ...,
    "snsTopicArn": ...,
}

parent.generate_data_set(**kwargs)

1. See GenerateDataSetRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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

start_support_data_export

Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available.

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").start_support_data_export method. boto3 documentation

# start_support_data_export method definition

await def start_support_data_export(
    self,
    *,
    dataSetType: SupportDataSetTypeType,  # (1)
    fromDate: Union[datetime, str],
    roleNameArn: str,
    destinationS3BucketName: str,
    snsTopicArn: str,
    destinationS3Prefix: str = ...,
    customerDefinedValues: Mapping[str, str] = ...,
) -> StartSupportDataExportResultTypeDef:  # (2)
    ...

1. See SupportDataSetTypeType
2. See StartSupportDataExportResultTypeDef

# start_support_data_export method usage example with argument unpacking

kwargs: StartSupportDataExportRequestRequestTypeDef = {  # (1)
    "dataSetType": ...,
    "fromDate": ...,
    "roleNameArn": ...,
    "destinationS3BucketName": ...,
    "snsTopicArn": ...,
}

parent.start_support_data_export(**kwargs)

1. See StartSupportDataExportRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> MarketplaceCommerceAnalyticsClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("marketplacecommerceanalytics").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...