MarketplaceCommerceAnalyticsClient

Index > MarketplaceCommerceAnalytics > MarketplaceCommerceAnalyticsClient

Auto-generated documentation for MarketplaceCommerceAnalytics type annotations stubs module mypy-boto3-marketplacecommerceanalytics.

MarketplaceCommerceAnalyticsClient

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

Usage example

from boto3.session import Session
from mypy_boto3_marketplacecommerceanalytics.client import MarketplaceCommerceAnalyticsClient

def get_marketplacecommerceanalytics_client() -> MarketplaceCommerceAnalyticsClient:
    return Session().client("marketplacecommerceanalytics")

Exceptions

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

Usage example

client = boto3.client("marketplacecommerceanalytics")

try:
    do_something(client)
except (
    client.ClientError,
    client.MarketplaceCommerceAnalyticsException,
) as e:
    print(e)

Type checking example

from mypy_boto3_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 boto3.client("marketplacecommerceanalytics").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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 boto3.client("marketplacecommerceanalytics").generate_data_set method. boto3 documentation

Method definition

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

Usage example with kwargs

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 boto3.client("marketplacecommerceanalytics").generate_presigned_url method. boto3 documentation

Method definition

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 boto3.client("marketplacecommerceanalytics").start_support_data_export method. boto3 documentation

Method definition

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

Usage example with kwargs

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

parent.start_support_data_export(**kwargs)

1. See StartSupportDataExportRequestRequestTypeDef