Skip to content

MarketplaceCatalogClient

Index > MarketplaceCatalog > MarketplaceCatalogClient

Auto-generated documentation for MarketplaceCatalog type annotations stubs module types-aiobotocore-marketplace-catalog.

MarketplaceCatalogClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_marketplace_catalog.client import MarketplaceCatalogClient

session = Session()
async with session.client("marketplace-catalog") as client:
    client: MarketplaceCatalogClient

Exceptions

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

Usage example
async with session.client("marketplace-catalog") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.InternalServiceException,
        client.ResourceInUseException,
        client.ResourceNotFoundException,
        client.ResourceNotSupportedException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_marketplace_catalog.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-catalog").can_paginate method. boto3 documentation

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

cancel_change_set

Used to cancel an open change request.

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

Method definition
await def cancel_change_set(
    self,
    *,
    Catalog: str,
    ChangeSetId: str,
) -> CancelChangeSetResponseTypeDef:  # (1)
    ...
  1. See CancelChangeSetResponseTypeDef
Usage example with kwargs
kwargs: CancelChangeSetRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ChangeSetId": ...,
}

parent.cancel_change_set(**kwargs)
  1. See CancelChangeSetRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

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

describe_change_set

Provides information about a given change set.

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

Method definition
await def describe_change_set(
    self,
    *,
    Catalog: str,
    ChangeSetId: str,
) -> DescribeChangeSetResponseTypeDef:  # (1)
    ...
  1. See DescribeChangeSetResponseTypeDef
Usage example with kwargs
kwargs: DescribeChangeSetRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ChangeSetId": ...,
}

parent.describe_change_set(**kwargs)
  1. See DescribeChangeSetRequestRequestTypeDef

describe_entity

Returns the metadata and content of the entity.

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

Method definition
await def describe_entity(
    self,
    *,
    Catalog: str,
    EntityId: str,
) -> DescribeEntityResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityResponseTypeDef
Usage example with kwargs
kwargs: DescribeEntityRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "EntityId": ...,
}

parent.describe_entity(**kwargs)
  1. See DescribeEntityRequestRequestTypeDef

generate_presigned_url

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

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

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

list_change_sets

Returns the list of change sets owned by the account being used to make the call.

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

Method definition
await def list_change_sets(
    self,
    *,
    Catalog: str,
    FilterList: Sequence[FilterTypeDef] = ...,  # (1)
    Sort: SortTypeDef = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChangeSetsResponseTypeDef:  # (3)
    ...
  1. See FilterTypeDef
  2. See SortTypeDef
  3. See ListChangeSetsResponseTypeDef
Usage example with kwargs
kwargs: ListChangeSetsRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
}

parent.list_change_sets(**kwargs)
  1. See ListChangeSetsRequestRequestTypeDef

list_entities

Provides the list of entities of a given type.

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

Method definition
await def list_entities(
    self,
    *,
    Catalog: str,
    EntityType: str,
    FilterList: Sequence[FilterTypeDef] = ...,  # (1)
    Sort: SortTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntitiesResponseTypeDef:  # (3)
    ...
  1. See FilterTypeDef
  2. See SortTypeDef
  3. See ListEntitiesResponseTypeDef
Usage example with kwargs
kwargs: ListEntitiesRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "EntityType": ...,
}

parent.list_entities(**kwargs)
  1. See ListEntitiesRequestRequestTypeDef

start_change_set

This operation allows you to request changes for your entities.

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

Method definition
await def start_change_set(
    self,
    *,
    Catalog: str,
    ChangeSet: Sequence[ChangeTypeDef],  # (1)
    ChangeSetName: str = ...,
    ClientRequestToken: str = ...,
) -> StartChangeSetResponseTypeDef:  # (2)
    ...
  1. See ChangeTypeDef
  2. See StartChangeSetResponseTypeDef
Usage example with kwargs
kwargs: StartChangeSetRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ChangeSet": ...,
}

parent.start_change_set(**kwargs)
  1. See StartChangeSetRequestRequestTypeDef

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> MarketplaceCatalogClient:
    ...

__aexit__

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

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