MarketplaceCatalogClient

Index > MarketplaceCatalog > MarketplaceCatalogClient

Auto-generated documentation for MarketplaceCatalog type annotations stubs module mypy-boto3-marketplace-catalog.

MarketplaceCatalogClient

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

# MarketplaceCatalogClient usage example

from boto3.session import Session
from mypy_boto3_marketplace_catalog.client import MarketplaceCatalogClient

def get_marketplace-catalog_client() -> MarketplaceCatalogClient:
    return Session().client("marketplace-catalog")

Exceptions

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

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServiceException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceNotSupportedException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_marketplace_catalog.client import Exceptions

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

Methods

batch_describe_entities

Returns metadata and content for multiple entities.

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

# batch_describe_entities method definition

def batch_describe_entities(
    self,
    *,
    EntityRequestList: Sequence[EntityRequestTypeDef],  # (1)
) -> BatchDescribeEntitiesResponseTypeDef:  # (2)
    ...

1. See EntityRequestTypeDef
2. See BatchDescribeEntitiesResponseTypeDef

# batch_describe_entities method usage example with argument unpacking

kwargs: BatchDescribeEntitiesRequestRequestTypeDef = {  # (1)
    "EntityRequestList": ...,
}

parent.batch_describe_entities(**kwargs)

1. See BatchDescribeEntitiesRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# can_paginate 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 boto3.client("marketplace-catalog").cancel_change_set method. boto3 documentation

# cancel_change_set method definition

def cancel_change_set(
    self,
    *,
    Catalog: str,
    ChangeSetId: str,
) -> CancelChangeSetResponseTypeDef:  # (1)
    ...

1. See CancelChangeSetResponseTypeDef

# cancel_change_set method usage example with argument unpacking

kwargs: CancelChangeSetRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ChangeSetId": ...,
}

parent.cancel_change_set(**kwargs)

1. See CancelChangeSetRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

# close method definition

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

delete_resource_policy

Deletes a resource-based policy on an entity that is identified by its resource ARN.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyRequestRequestTypeDef

describe_change_set

Provides information about a given change set.

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

# describe_change_set method definition

def describe_change_set(
    self,
    *,
    Catalog: str,
    ChangeSetId: str,
) -> DescribeChangeSetResponseTypeDef:  # (1)
    ...

1. See DescribeChangeSetResponseTypeDef

# describe_change_set method usage example with argument unpacking

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

# describe_entity method definition

def describe_entity(
    self,
    *,
    Catalog: str,
    EntityId: str,
) -> DescribeEntityResponseTypeDef:  # (1)
    ...

1. See DescribeEntityResponseTypeDef

# describe_entity method usage example with argument unpacking

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 boto3.client("marketplace-catalog").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_resource_policy

Gets a resource-based policy of an entity that is identified by its resource ARN.

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

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...

1. See GetResourcePolicyResponseTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyRequestRequestTypeDef

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

# list_change_sets method definition

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

# list_change_sets method usage example with argument unpacking

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

# list_entities method definition

def list_entities(
    self,
    *,
    Catalog: str,
    EntityType: str,
    FilterList: Sequence[FilterTypeDef] = ...,  # (1)
    Sort: SortTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    OwnershipType: OwnershipTypeType = ...,  # (3)
    EntityTypeFilters: EntityTypeFiltersTypeDef = ...,  # (4)
    EntityTypeSort: EntityTypeSortTypeDef = ...,  # (5)
) -> ListEntitiesResponseTypeDef:  # (6)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See OwnershipTypeType
4. See EntityTypeFiltersTypeDef
5. See EntityTypeSortTypeDef
6. See ListEntitiesResponseTypeDef

# list_entities method usage example with argument unpacking

kwargs: ListEntitiesRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "EntityType": ...,
}

parent.list_entities(**kwargs)

1. See ListEntitiesRequestRequestTypeDef

list_tags_for_resource

Lists all tags that have been added to a resource (either an entity or change set <https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-se....

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_resource_policy

Attaches a resource-based policy to an entity.

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...

# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyRequestRequestTypeDef

start_change_set

Allows you to request changes for your entities.

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

# start_change_set method definition

def start_change_set(
    self,
    *,
    Catalog: str,
    ChangeSet: Sequence[ChangeTypeDef],  # (1)
    ChangeSetName: str = ...,
    ClientRequestToken: str = ...,
    ChangeSetTags: Sequence[TagTypeDef] = ...,  # (2)
    Intent: IntentType = ...,  # (3)
) -> StartChangeSetResponseTypeDef:  # (4)
    ...

1. See ChangeTypeDef
2. See TagTypeDef
3. See IntentType
4. See StartChangeSetResponseTypeDef

# start_change_set method usage example with argument unpacking

kwargs: StartChangeSetRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ChangeSet": ...,
}

parent.start_change_set(**kwargs)

1. See StartChangeSetRequestRequestTypeDef

tag_resource

Tags a resource (either an entity or change set).

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag or list of tags from a resource (either an entity or change set...

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("marketplace-catalog").get_paginator method with overloads.

• client.get_paginator("list_change_sets") -> ListChangeSetsPaginator
• client.get_paginator("list_entities") -> ListEntitiesPaginator