PartnerCentralSellingAPIClient

Index > PartnerCentralSellingAPI > PartnerCentralSellingAPIClient

Auto-generated documentation for PartnerCentralSellingAPI type annotations stubs module mypy-boto3-partnercentral-selling.

PartnerCentralSellingAPIClient

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

# PartnerCentralSellingAPIClient usage example

from boto3.session import Session
from mypy_boto3_partnercentral_selling.client import PartnerCentralSellingAPIClient

def get_partnercentral-selling_client() -> PartnerCentralSellingAPIClient:
    return Session().client("partnercentral-selling")

Exceptions

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

# Exceptions.exceptions usage example

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

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_selling.client import Exceptions

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

Methods

assign_opportunity

Enables you to reassign an existing Opportunity to another user within your Partner Central account.

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

# assign_opportunity method definition

def assign_opportunity(
    self,
    *,
    Assignee: AssigneeContactTypeDef,  # (1)
    Catalog: str,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See AssigneeContactTypeDef
2. See EmptyResponseMetadataTypeDef

# assign_opportunity method usage example with argument unpacking

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

parent.assign_opportunity(**kwargs)

1. See AssignOpportunityRequestRequestTypeDef

associate_opportunity

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making.

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

# associate_opportunity method definition

def associate_opportunity(
    self,
    *,
    Catalog: str,
    OpportunityIdentifier: str,
    RelatedEntityIdentifier: str,
    RelatedEntityType: RelatedEntityTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See RelatedEntityTypeType
2. See EmptyResponseMetadataTypeDef

# associate_opportunity method usage example with argument unpacking

kwargs: AssociateOpportunityRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "OpportunityIdentifier": ...,
    "RelatedEntityIdentifier": ...,
    "RelatedEntityType": ...,
}

parent.associate_opportunity(**kwargs)

1. See AssociateOpportunityRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# close method definition

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

create_opportunity

Creates an Opportunity record in Partner Central.

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

# create_opportunity method definition

def create_opportunity(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    Customer: CustomerTypeDef = ...,  # (1)
    LifeCycle: LifeCycleTypeDef = ...,  # (2)
    Marketing: MarketingTypeDef = ...,  # (3)
    NationalSecurity: NationalSecurityType = ...,  # (4)
    OpportunityTeam: Sequence[ContactTypeDef] = ...,  # (5)
    OpportunityType: OpportunityTypeType = ...,  # (6)
    Origin: OpportunityOriginType = ...,  # (7)
    PartnerOpportunityIdentifier: str = ...,
    PrimaryNeedsFromAws: Sequence[PrimaryNeedFromAwsType] = ...,  # (8)
    Project: ProjectTypeDef = ...,  # (9)
    SoftwareRevenue: SoftwareRevenueTypeDef = ...,  # (10)
) -> CreateOpportunityResponseTypeDef:  # (11)
    ...

1. See CustomerTypeDef
2. See LifeCycleTypeDef
3. See MarketingTypeDef
4. See NationalSecurityType
5. See ContactTypeDef
6. See OpportunityTypeType
7. See OpportunityOriginType
8. See PrimaryNeedFromAwsType
9. See ProjectTypeDef
10. See SoftwareRevenueTypeDef
11. See CreateOpportunityResponseTypeDef

# create_opportunity method usage example with argument unpacking

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

parent.create_opportunity(**kwargs)

1. See CreateOpportunityRequestRequestTypeDef

disassociate_opportunity

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer.

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

# disassociate_opportunity method definition

def disassociate_opportunity(
    self,
    *,
    Catalog: str,
    OpportunityIdentifier: str,
    RelatedEntityIdentifier: str,
    RelatedEntityType: RelatedEntityTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See RelatedEntityTypeType
2. See EmptyResponseMetadataTypeDef

# disassociate_opportunity method usage example with argument unpacking

kwargs: DisassociateOpportunityRequestRequestTypeDef = {  # (1)
    "Catalog": ...,
    "OpportunityIdentifier": ...,
    "RelatedEntityIdentifier": ...,
    "RelatedEntityType": ...,
}

parent.disassociate_opportunity(**kwargs)

1. See DisassociateOpportunityRequestRequestTypeDef

generate_presigned_url

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

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

Retrieves a summary of an AWS Opportunity.

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

# get_aws_opportunity_summary method definition

def get_aws_opportunity_summary(
    self,
    *,
    Catalog: str,
    RelatedOpportunityIdentifier: str,
) -> GetAwsOpportunitySummaryResponseTypeDef:  # (1)
    ...

1. See GetAwsOpportunitySummaryResponseTypeDef

# get_aws_opportunity_summary method usage example with argument unpacking

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

parent.get_aws_opportunity_summary(**kwargs)

1. See GetAwsOpportunitySummaryRequestRequestTypeDef

get_engagement_invitation

Retrieves the details of an engagement invitation shared by AWS with a partner.

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

# get_engagement_invitation method definition

def get_engagement_invitation(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetEngagementInvitationResponseTypeDef:  # (1)
    ...

1. See GetEngagementInvitationResponseTypeDef

# get_engagement_invitation method usage example with argument unpacking

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

parent.get_engagement_invitation(**kwargs)

1. See GetEngagementInvitationRequestRequestTypeDef

get_opportunity

Fetches the Opportunity record from Partner Central by a given Identifier.

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

# get_opportunity method definition

def get_opportunity(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetOpportunityResponseTypeDef:  # (1)
    ...

1. See GetOpportunityResponseTypeDef

# get_opportunity method usage example with argument unpacking

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

parent.get_opportunity(**kwargs)

1. See GetOpportunityRequestRequestTypeDef

list_engagement_invitations

Retrieves a list of engagement invitations sent to the partner.

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

# list_engagement_invitations method definition

def list_engagement_invitations(
    self,
    *,
    Catalog: str,
    ParticipantType: ParticipantTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    PayloadType: Sequence[EngagementInvitationPayloadTypeType] = ...,  # (2)
    Sort: OpportunityEngagementInvitationSortTypeDef = ...,  # (3)
) -> ListEngagementInvitationsResponseTypeDef:  # (4)
    ...

1. See ParticipantTypeType
2. See EngagementInvitationPayloadTypeType
3. See OpportunityEngagementInvitationSortTypeDef
4. See ListEngagementInvitationsResponseTypeDef

# list_engagement_invitations method usage example with argument unpacking

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

parent.list_engagement_invitations(**kwargs)

1. See ListEngagementInvitationsRequestRequestTypeDef

list_opportunities

This request accepts a list of filters that retrieve opportunity subsets as well as sort options.

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

# list_opportunities method definition

def list_opportunities(
    self,
    *,
    Catalog: str,
    CustomerCompanyName: Sequence[str] = ...,
    Identifier: Sequence[str] = ...,
    LastModifiedDate: LastModifiedDateTypeDef = ...,  # (1)
    LifeCycleReviewStatus: Sequence[ReviewStatusType] = ...,  # (2)
    LifeCycleStage: Sequence[StageType] = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
    Sort: OpportunitySortTypeDef = ...,  # (4)
) -> ListOpportunitiesResponseTypeDef:  # (5)
    ...

1. See LastModifiedDateTypeDef
2. See ReviewStatusType
3. See StageType
4. See OpportunitySortTypeDef
5. See ListOpportunitiesResponseTypeDef

# list_opportunities method usage example with argument unpacking

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

parent.list_opportunities(**kwargs)

1. See ListOpportunitiesRequestRequestTypeDef

list_solutions

Retrieves a list of Partner Solutions that the partner registered on Partner Central.

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

# list_solutions method definition

def list_solutions(
    self,
    *,
    Catalog: str,
    Category: Sequence[str] = ...,
    Identifier: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Sort: SolutionSortTypeDef = ...,  # (1)
    Status: Sequence[SolutionStatusType] = ...,  # (2)
) -> ListSolutionsResponseTypeDef:  # (3)
    ...

1. See SolutionSortTypeDef
2. See SolutionStatusType
3. See ListSolutionsResponseTypeDef

# list_solutions method usage example with argument unpacking

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

parent.list_solutions(**kwargs)

1. See ListSolutionsRequestRequestTypeDef

reject_engagement_invitation

This action rejects an EngagementInvitation that AWS shared.

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

# reject_engagement_invitation method definition

def reject_engagement_invitation(
    self,
    *,
    Catalog: str,
    Identifier: str,
    RejectionReason: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# reject_engagement_invitation method usage example with argument unpacking

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

parent.reject_engagement_invitation(**kwargs)

1. See RejectEngagementInvitationRequestRequestTypeDef

start_engagement_by_accepting_invitation_task

This action starts the engagement by accepting an EngagementInvitation.

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

# start_engagement_by_accepting_invitation_task method definition

def start_engagement_by_accepting_invitation_task(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    Identifier: str,
) -> StartEngagementByAcceptingInvitationTaskResponseTypeDef:  # (1)
    ...

1. See StartEngagementByAcceptingInvitationTaskResponseTypeDef

# start_engagement_by_accepting_invitation_task method usage example with argument unpacking

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

parent.start_engagement_by_accepting_invitation_task(**kwargs)

1. See StartEngagementByAcceptingInvitationTaskRequestRequestTypeDef

start_engagement_from_opportunity_task

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner's system.

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

# start_engagement_from_opportunity_task method definition

def start_engagement_from_opportunity_task(
    self,
    *,
    AwsSubmission: AwsSubmissionTypeDef,  # (1)
    Catalog: str,
    ClientToken: str,
    Identifier: str,
) -> StartEngagementFromOpportunityTaskResponseTypeDef:  # (2)
    ...

1. See AwsSubmissionTypeDef
2. See StartEngagementFromOpportunityTaskResponseTypeDef

# start_engagement_from_opportunity_task method usage example with argument unpacking

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

parent.start_engagement_from_opportunity_task(**kwargs)

1. See StartEngagementFromOpportunityTaskRequestRequestTypeDef

update_opportunity

Updates the Opportunity record identified by a given Identifier.

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

# update_opportunity method definition

def update_opportunity(
    self,
    *,
    Catalog: str,
    Identifier: str,
    LastModifiedDate: TimestampTypeDef,
    Customer: CustomerTypeDef = ...,  # (1)
    LifeCycle: LifeCycleTypeDef = ...,  # (2)
    Marketing: MarketingTypeDef = ...,  # (3)
    NationalSecurity: NationalSecurityType = ...,  # (4)
    OpportunityType: OpportunityTypeType = ...,  # (5)
    PartnerOpportunityIdentifier: str = ...,
    PrimaryNeedsFromAws: Sequence[PrimaryNeedFromAwsType] = ...,  # (6)
    Project: ProjectTypeDef = ...,  # (7)
    SoftwareRevenue: SoftwareRevenueTypeDef = ...,  # (8)
) -> UpdateOpportunityResponseTypeDef:  # (9)
    ...

1. See CustomerTypeDef
2. See LifeCycleTypeDef
3. See MarketingTypeDef
4. See NationalSecurityType
5. See OpportunityTypeType
6. See PrimaryNeedFromAwsType
7. See ProjectTypeDef
8. See SoftwareRevenueTypeDef
9. See UpdateOpportunityResponseTypeDef

# update_opportunity method usage example with argument unpacking

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

parent.update_opportunity(**kwargs)

1. See UpdateOpportunityRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_engagement_invitations") -> ListEngagementInvitationsPaginator
• client.get_paginator("list_opportunities") -> ListOpportunitiesPaginator
• client.get_paginator("list_solutions") -> ListSolutionsPaginator