PartnerCentralBenefitsClient

Index > PartnerCentralBenefits > PartnerCentralBenefitsClient

Auto-generated documentation for PartnerCentralBenefits type annotations stubs module mypy-boto3-partnercentral-benefits.

PartnerCentralBenefitsClient

Type annotations and code completion for boto3.client("partnercentral-benefits"). boto3 documentation

# PartnerCentralBenefitsClient usage example

from boto3.session import Session
from mypy_boto3_partnercentral_benefits.client import PartnerCentralBenefitsClient

def get_partnercentral-benefits_client() -> PartnerCentralBenefitsClient:
    return Session().client("partnercentral-benefits")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("partnercentral-benefits")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_partnercentral_benefits.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

amend_benefit_application

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

Type annotations and code completion for boto3.client("partnercentral-benefits").amend_benefit_application method. boto3 documentation

# amend_benefit_application method definition

def amend_benefit_application(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    Revision: str,
    Identifier: str,
    AmendmentReason: str,
    Amendments: Sequence[AmendmentTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See Sequence[AmendmentTypeDef]

# amend_benefit_application method usage example with argument unpacking

kwargs: AmendBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ClientToken": ...,
    "Revision": ...,
    "Identifier": ...,
    "AmendmentReason": ...,
    "Amendments": ...,
}

parent.amend_benefit_application(**kwargs)

1. See AmendBenefitApplicationInputTypeDef

associate_benefit_application_resource

Links an AWS resource to an existing benefit application for tracking and management purposes.

Type annotations and code completion for boto3.client("partnercentral-benefits").associate_benefit_application_resource method. boto3 documentation

# associate_benefit_application_resource method definition

def associate_benefit_application_resource(
    self,
    *,
    Catalog: str,
    BenefitApplicationIdentifier: str,
    ResourceArn: str,
) -> AssociateBenefitApplicationResourceOutputTypeDef:  # (1)
    ...

1. See AssociateBenefitApplicationResourceOutputTypeDef

# associate_benefit_application_resource method usage example with argument unpacking

kwargs: AssociateBenefitApplicationResourceInputTypeDef = {  # (1)
    "Catalog": ...,
    "BenefitApplicationIdentifier": ...,
    "ResourceArn": ...,
}

parent.associate_benefit_application_resource(**kwargs)

1. See AssociateBenefitApplicationResourceInputTypeDef

cancel_benefit_application

Cancels a benefit application that is currently in progress, preventing further processing.

Type annotations and code completion for boto3.client("partnercentral-benefits").cancel_benefit_application method. boto3 documentation

# cancel_benefit_application method definition

def cancel_benefit_application(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    Identifier: str,
    Reason: str = ...,
) -> dict[str, Any]:
    ...

# cancel_benefit_application method usage example with argument unpacking

kwargs: CancelBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ClientToken": ...,
    "Identifier": ...,
}

parent.cancel_benefit_application(**kwargs)

1. See CancelBenefitApplicationInputTypeDef

create_benefit_application

Creates a new benefit application for a partner to request access to AWS benefits and programs.

Type annotations and code completion for boto3.client("partnercentral-benefits").create_benefit_application method. boto3 documentation

# create_benefit_application method definition

def create_benefit_application(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    BenefitIdentifier: str,
    Name: str = ...,
    Description: str = ...,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    BenefitApplicationDetails: Mapping[str, Any] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    AssociatedResources: Sequence[str] = ...,
    PartnerContacts: Sequence[ContactTypeDef] = ...,  # (3)
    FileDetails: Sequence[FileInputTypeDef] = ...,  # (4)
) -> CreateBenefitApplicationOutputTypeDef:  # (5)
    ...

1. See Sequence[FulfillmentTypeType]
2. See Sequence[TagTypeDef]
3. See Sequence[ContactTypeDef]
4. See Sequence[FileInputTypeDef]
5. See CreateBenefitApplicationOutputTypeDef

# create_benefit_application method usage example with argument unpacking

kwargs: CreateBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ClientToken": ...,
    "BenefitIdentifier": ...,
}

parent.create_benefit_application(**kwargs)

1. See CreateBenefitApplicationInputTypeDef

disassociate_benefit_application_resource

Removes the association between an AWS resource and a benefit application.

Type annotations and code completion for boto3.client("partnercentral-benefits").disassociate_benefit_application_resource method. boto3 documentation

# disassociate_benefit_application_resource method definition

def disassociate_benefit_application_resource(
    self,
    *,
    Catalog: str,
    BenefitApplicationIdentifier: str,
    ResourceArn: str,
) -> DisassociateBenefitApplicationResourceOutputTypeDef:  # (1)
    ...

1. See DisassociateBenefitApplicationResourceOutputTypeDef

# disassociate_benefit_application_resource method usage example with argument unpacking

kwargs: DisassociateBenefitApplicationResourceInputTypeDef = {  # (1)
    "Catalog": ...,
    "BenefitApplicationIdentifier": ...,
    "ResourceArn": ...,
}

parent.disassociate_benefit_application_resource(**kwargs)

1. See DisassociateBenefitApplicationResourceInputTypeDef

get_benefit

Retrieves detailed information about a specific benefit available in the partner catalog.

Type annotations and code completion for boto3.client("partnercentral-benefits").get_benefit method. boto3 documentation

# get_benefit method definition

def get_benefit(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetBenefitOutputTypeDef:  # (1)
    ...

1. See GetBenefitOutputTypeDef

# get_benefit method usage example with argument unpacking

kwargs: GetBenefitInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
}

parent.get_benefit(**kwargs)

1. See GetBenefitInputTypeDef

get_benefit_allocation

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

Type annotations and code completion for boto3.client("partnercentral-benefits").get_benefit_allocation method. boto3 documentation

# get_benefit_allocation method definition

def get_benefit_allocation(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetBenefitAllocationOutputTypeDef:  # (1)
    ...

1. See GetBenefitAllocationOutputTypeDef

# get_benefit_allocation method usage example with argument unpacking

kwargs: GetBenefitAllocationInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
}

parent.get_benefit_allocation(**kwargs)

1. See GetBenefitAllocationInputTypeDef

get_benefit_application

Retrieves detailed information about a specific benefit application.

Type annotations and code completion for boto3.client("partnercentral-benefits").get_benefit_application method. boto3 documentation

# get_benefit_application method definition

def get_benefit_application(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetBenefitApplicationOutputTypeDef:  # (1)
    ...

1. See GetBenefitApplicationOutputTypeDef

# get_benefit_application method usage example with argument unpacking

kwargs: GetBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
}

parent.get_benefit_application(**kwargs)

1. See GetBenefitApplicationInputTypeDef

list_benefit_allocations

Retrieves a paginated list of benefit allocations based on specified filter criteria.

Type annotations and code completion for boto3.client("partnercentral-benefits").list_benefit_allocations method. boto3 documentation

# list_benefit_allocations method definition

def list_benefit_allocations(
    self,
    *,
    Catalog: str,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    BenefitIdentifiers: Sequence[str] = ...,
    BenefitApplicationIdentifiers: Sequence[str] = ...,
    Status: Sequence[BenefitAllocationStatusType] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBenefitAllocationsOutputTypeDef:  # (3)
    ...

1. See Sequence[FulfillmentTypeType]
2. See Sequence[BenefitAllocationStatusType]
3. See ListBenefitAllocationsOutputTypeDef

# list_benefit_allocations method usage example with argument unpacking

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

parent.list_benefit_allocations(**kwargs)

1. See ListBenefitAllocationsInputTypeDef

list_benefit_applications

Retrieves a paginated list of benefit applications based on specified filter criteria.

Type annotations and code completion for boto3.client("partnercentral-benefits").list_benefit_applications method. boto3 documentation

# list_benefit_applications method definition

def list_benefit_applications(
    self,
    *,
    Catalog: str,
    Programs: Sequence[str] = ...,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    BenefitIdentifiers: Sequence[str] = ...,
    Status: Sequence[BenefitApplicationStatusType] = ...,  # (2)
    Stages: Sequence[str] = ...,
    AssociatedResources: Sequence[AssociatedResourceTypeDef] = ...,  # (3)
    AssociatedResourceArns: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBenefitApplicationsOutputTypeDef:  # (4)
    ...

1. See Sequence[FulfillmentTypeType]
2. See Sequence[BenefitApplicationStatusType]
3. See Sequence[AssociatedResourceTypeDef]
4. See ListBenefitApplicationsOutputTypeDef

# list_benefit_applications method usage example with argument unpacking

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

parent.list_benefit_applications(**kwargs)

1. See ListBenefitApplicationsInputTypeDef

list_benefits

Retrieves a paginated list of available benefits based on specified filter criteria.

Type annotations and code completion for boto3.client("partnercentral-benefits").list_benefits method. boto3 documentation

# list_benefits method definition

def list_benefits(
    self,
    *,
    Catalog: str,
    Programs: Sequence[str] = ...,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    Status: Sequence[BenefitStatusType] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBenefitsOutputTypeDef:  # (3)
    ...

1. See Sequence[FulfillmentTypeType]
2. See Sequence[BenefitStatusType]
3. See ListBenefitsOutputTypeDef

# list_benefits method usage example with argument unpacking

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

parent.list_benefits(**kwargs)

1. See ListBenefitsInputTypeDef

list_tags_for_resource

Retrieves all tags associated with a specific resource.

Type annotations and code completion for boto3.client("partnercentral-benefits").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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

recall_benefit_application

Recalls a submitted benefit application, returning it to draft status for further modifications.

Type annotations and code completion for boto3.client("partnercentral-benefits").recall_benefit_application method. boto3 documentation

# recall_benefit_application method definition

def recall_benefit_application(
    self,
    *,
    Catalog: str,
    Identifier: str,
    Reason: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...

# recall_benefit_application method usage example with argument unpacking

kwargs: RecallBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
    "Reason": ...,
}

parent.recall_benefit_application(**kwargs)

1. See RecallBenefitApplicationInputTypeDef

submit_benefit_application

Submits a benefit application for review and processing by AWS.

Type annotations and code completion for boto3.client("partnercentral-benefits").submit_benefit_application method. boto3 documentation

# submit_benefit_application method definition

def submit_benefit_application(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> dict[str, Any]:
    ...

# submit_benefit_application method usage example with argument unpacking

kwargs: SubmitBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
}

parent.submit_benefit_application(**kwargs)

1. See SubmitBenefitApplicationInputTypeDef

tag_resource

Adds or updates tags for a specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes specified tags from a resource.

Type annotations and code completion for boto3.client("partnercentral-benefits").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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_benefit_application

Updates an existing benefit application with new information while maintaining revision control.

Type annotations and code completion for boto3.client("partnercentral-benefits").update_benefit_application method. boto3 documentation

# update_benefit_application method definition

def update_benefit_application(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    Identifier: str,
    Revision: str,
    Name: str = ...,
    Description: str = ...,
    BenefitApplicationDetails: Mapping[str, Any] = ...,
    PartnerContacts: Sequence[ContactTypeDef] = ...,  # (1)
    FileDetails: Sequence[FileInputTypeDef] = ...,  # (2)
) -> UpdateBenefitApplicationOutputTypeDef:  # (3)
    ...

1. See Sequence[ContactTypeDef]
2. See Sequence[FileInputTypeDef]
3. See UpdateBenefitApplicationOutputTypeDef

# update_benefit_application method usage example with argument unpacking

kwargs: UpdateBenefitApplicationInputTypeDef = {  # (1)
    "Catalog": ...,
    "ClientToken": ...,
    "Identifier": ...,
    "Revision": ...,
}

parent.update_benefit_application(**kwargs)

1. See UpdateBenefitApplicationInputTypeDef

get_paginator

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

• client.get_paginator("list_benefit_allocations") -> ListBenefitAllocationsPaginator
• client.get_paginator("list_benefit_applications") -> ListBenefitApplicationsPaginator
• client.get_paginator("list_benefits") -> ListBenefitsPaginator