AgreementServiceClient

Index > AgreementService > AgreementServiceClient

Auto-generated documentation for AgreementService type annotations stubs module types-aiobotocore-marketplace-agreement.

AgreementServiceClient

Type annotations and code completion for session.client("marketplace-agreement") boto3 documentation

# AgreementServiceClient usage example

from aioboto3.session import Session
from types_aiobotocore_marketplace_agreement.client import AgreementServiceClient

session = Session()
async with session.client("marketplace-agreement") as client:
    client: AgreementServiceClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("marketplace-agreement").exceptions structure.

# AgreementServiceClient.exceptions usage example

async with session.client("marketplace-agreement") as client:
    try:
        do_something(client)
    except (
            client.exceptions.AccessDeniedException,
        client.exceptions.ClientError,
        client.exceptions.InternalServerException,
        client.exceptions.ResourceNotFoundException,
        client.exceptions.ThrottlingException,
        client.exceptions.ValidationException,
    ) as e:
        print(e)

# AgreementServiceClient.exceptions type checking example

from types_aiobotocore_marketplace_agreement.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("marketplace-agreement").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.client("marketplace-agreement").close method. boto3 documentation

# close method definition

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

describe_agreement

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Type annotations and code completion for session.client("marketplace-agreement").describe_agreement method. boto3 documentation

# describe_agreement method definition

await def describe_agreement(
    self,
    *,
    agreementId: str,
) -> DescribeAgreementOutputTypeDef:  # (1)
    ...

1. See DescribeAgreementOutputTypeDef

# describe_agreement method usage example with argument unpacking

kwargs: DescribeAgreementInputRequestTypeDef = {  # (1)
    "agreementId": ...,
}

parent.describe_agreement(**kwargs)

1. See DescribeAgreementInputRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for session.client("marketplace-agreement").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:
    ...

get_agreement_terms

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

Type annotations and code completion for session.client("marketplace-agreement").get_agreement_terms method. boto3 documentation

# get_agreement_terms method definition

await def get_agreement_terms(
    self,
    *,
    agreementId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetAgreementTermsOutputTypeDef:  # (1)
    ...

1. See GetAgreementTermsOutputTypeDef

# get_agreement_terms method usage example with argument unpacking

kwargs: GetAgreementTermsInputRequestTypeDef = {  # (1)
    "agreementId": ...,
}

parent.get_agreement_terms(**kwargs)

1. See GetAgreementTermsInputRequestTypeDef

search_agreements

Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.

Type annotations and code completion for session.client("marketplace-agreement").search_agreements method. boto3 documentation

# search_agreements method definition

await def search_agreements(
    self,
    *,
    catalog: str = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sort: SortTypeDef = ...,  # (2)
) -> SearchAgreementsOutputTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchAgreementsOutputTypeDef

# search_agreements method usage example with argument unpacking

kwargs: SearchAgreementsInputRequestTypeDef = {  # (1)
    "catalog": ...,
}

parent.search_agreements(**kwargs)

1. See SearchAgreementsInputRequestTypeDef

__aenter__

Type annotations and code completion for session.client("marketplace-agreement").__aenter__ method. boto3 documentation

# __aenter__ method definition

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

__aexit__

Type annotations and code completion for session.client("marketplace-agreement").__aexit__ method. boto3 documentation

# __aexit__ method definition

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