AgreementServiceClient#

Index > AgreementService > AgreementServiceClient

Auto-generated documentation for AgreementService type annotations stubs module mypy-boto3-marketplace-agreement.

AgreementServiceClient#

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

# AgreementServiceClient usage example

from boto3.session import Session
from mypy_boto3_marketplace_agreement.client import AgreementServiceClient

def get_marketplace-agreement_client() -> AgreementServiceClient:
    return Session().client("marketplace-agreement")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("marketplace-agreement")

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)

# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.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 boto3.client("marketplace-agreement").close method. boto3 documentation

# close method definition

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 boto3.client("marketplace-agreement").describe_agreement method. boto3 documentation

# describe_agreement method definition

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

See DescribeAgreementOutputTypeDef

# describe_agreement method usage example with argument unpacking

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

parent.describe_agreement(**kwargs)

See DescribeAgreementInputRequestTypeDef

generate_presigned_url#

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

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

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 boto3.client("marketplace-agreement").get_agreement_terms method. boto3 documentation

# get_agreement_terms method definition

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

See GetAgreementTermsOutputTypeDef

# get_agreement_terms method usage example with argument unpacking

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

parent.get_agreement_terms(**kwargs)

See GetAgreementTermsInputRequestTypeDef

search_agreements#

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

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

# search_agreements method definition

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

# search_agreements method usage example with argument unpacking

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

parent.search_agreements(**kwargs)

See SearchAgreementsInputRequestTypeDef