PartnerCentralAccountAPIClient

Index > PartnerCentralAccountAPI > PartnerCentralAccountAPIClient

Auto-generated documentation for PartnerCentralAccountAPI type annotations stubs module mypy-boto3-partnercentral-account.

PartnerCentralAccountAPIClient

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

# PartnerCentralAccountAPIClient usage example

from boto3.session import Session
from mypy_boto3_partnercentral_account.client import PartnerCentralAccountAPIClient

def get_partnercentral-account_client() -> PartnerCentralAccountAPIClient:
    return Session().client("partnercentral-account")

Exceptions

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

# Exceptions.exceptions usage example

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

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

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

Methods

can_paginate

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

accept_connection_invitation

Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.

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

# accept_connection_invitation method definition

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

1. See AcceptConnectionInvitationResponseTypeDef

# accept_connection_invitation method usage example with argument unpacking

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

parent.accept_connection_invitation(**kwargs)

1. See AcceptConnectionInvitationRequestTypeDef

associate_aws_training_certification_email_domain

Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.

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

# associate_aws_training_certification_email_domain method definition

def associate_aws_training_certification_email_domain(
    self,
    *,
    Catalog: str,
    Identifier: str,
    Email: str,
    EmailVerificationCode: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...

# associate_aws_training_certification_email_domain method usage example with argument unpacking

kwargs: AssociateAwsTrainingCertificationEmailDomainRequestTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
    "Email": ...,
    "EmailVerificationCode": ...,
}

parent.associate_aws_training_certification_email_domain(**kwargs)

1. See AssociateAwsTrainingCertificationEmailDomainRequestTypeDef

cancel_connection

Cancels an existing connection between partners, terminating the partnership relationship.

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

# cancel_connection method definition

def cancel_connection(
    self,
    *,
    Catalog: str,
    Identifier: str,
    ConnectionType: ConnectionTypeType,  # (1)
    Reason: str,
    ClientToken: str,
) -> CancelConnectionResponseTypeDef:  # (2)
    ...

1. See ConnectionTypeType
2. See CancelConnectionResponseTypeDef

# cancel_connection method usage example with argument unpacking

kwargs: CancelConnectionRequestTypeDef = {  # (1)
    "Catalog": ...,
    "Identifier": ...,
    "ConnectionType": ...,
    "Reason": ...,
    "ClientToken": ...,
}

parent.cancel_connection(**kwargs)

1. See CancelConnectionRequestTypeDef

cancel_connection_invitation

Cancels a pending connection invitation before it has been accepted or rejected.

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

# cancel_connection_invitation method definition

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

1. See CancelConnectionInvitationResponseTypeDef

# cancel_connection_invitation method usage example with argument unpacking

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

parent.cancel_connection_invitation(**kwargs)

1. See CancelConnectionInvitationRequestTypeDef

cancel_profile_update_task

Cancels an in-progress profile update task, stopping any pending changes to the partner profile.

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

# cancel_profile_update_task method definition

def cancel_profile_update_task(
    self,
    *,
    Catalog: str,
    Identifier: str,
    TaskId: str,
    ClientToken: str = ...,
) -> CancelProfileUpdateTaskResponseTypeDef:  # (1)
    ...

1. See CancelProfileUpdateTaskResponseTypeDef

# cancel_profile_update_task method usage example with argument unpacking

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

parent.cancel_profile_update_task(**kwargs)

1. See CancelProfileUpdateTaskRequestTypeDef

create_connection_invitation

Creates a new connection invitation to establish a partnership with another organization.

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

# create_connection_invitation method definition

def create_connection_invitation(
    self,
    *,
    Catalog: str,
    ClientToken: str,
    ConnectionType: ConnectionTypeType,  # (1)
    Email: str,
    Message: str,
    Name: str,
    ReceiverIdentifier: str,
) -> CreateConnectionInvitationResponseTypeDef:  # (2)
    ...

1. See ConnectionTypeType
2. See CreateConnectionInvitationResponseTypeDef

# create_connection_invitation method usage example with argument unpacking

kwargs: CreateConnectionInvitationRequestTypeDef = {  # (1)
    "Catalog": ...,
    "ClientToken": ...,
    "ConnectionType": ...,
    "Email": ...,
    "Message": ...,
    "Name": ...,
    "ReceiverIdentifier": ...,
}

parent.create_connection_invitation(**kwargs)

1. See CreateConnectionInvitationRequestTypeDef

create_partner

Creates a new partner account in the AWS Partner Network with the specified details and configuration.

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

# create_partner method definition

def create_partner(
    self,
    *,
    Catalog: str,
    LegalName: str,
    PrimarySolutionType: PrimarySolutionTypeType,  # (1)
    AllianceLeadContact: AllianceLeadContactTypeDef,  # (2)
    EmailVerificationCode: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreatePartnerResponseTypeDef:  # (4)
    ...

1. See PrimarySolutionTypeType
2. See AllianceLeadContactTypeDef
3. See Sequence[TagTypeDef]
4. See CreatePartnerResponseTypeDef

# create_partner method usage example with argument unpacking

kwargs: CreatePartnerRequestTypeDef = {  # (1)
    "Catalog": ...,
    "LegalName": ...,
    "PrimarySolutionType": ...,
    "AllianceLeadContact": ...,
    "EmailVerificationCode": ...,
}

parent.create_partner(**kwargs)

1. See CreatePartnerRequestTypeDef

disassociate_aws_training_certification_email_domain

Removes the association between an email domain and AWS training and certification for the partner account.

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

# disassociate_aws_training_certification_email_domain method definition

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

# disassociate_aws_training_certification_email_domain method usage example with argument unpacking

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

parent.disassociate_aws_training_certification_email_domain(**kwargs)

1. See DisassociateAwsTrainingCertificationEmailDomainRequestTypeDef

get_alliance_lead_contact

Retrieves the alliance lead contact information for a partner account.

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

# get_alliance_lead_contact method definition

def get_alliance_lead_contact(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetAllianceLeadContactResponseTypeDef:  # (1)
    ...

1. See GetAllianceLeadContactResponseTypeDef

# get_alliance_lead_contact method usage example with argument unpacking

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

parent.get_alliance_lead_contact(**kwargs)

1. See GetAllianceLeadContactRequestTypeDef

get_connection

Retrieves detailed information about a specific connection between partners.

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

# get_connection method definition

def get_connection(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetConnectionResponseTypeDef:  # (1)
    ...

1. See GetConnectionResponseTypeDef

# get_connection method usage example with argument unpacking

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

parent.get_connection(**kwargs)

1. See GetConnectionRequestTypeDef

get_connection_invitation

Retrieves detailed information about a specific connection invitation.

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

# get_connection_invitation method definition

def get_connection_invitation(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetConnectionInvitationResponseTypeDef:  # (1)
    ...

1. See GetConnectionInvitationResponseTypeDef

# get_connection_invitation method usage example with argument unpacking

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

parent.get_connection_invitation(**kwargs)

1. See GetConnectionInvitationRequestTypeDef

get_connection_preferences

Retrieves the connection preferences for a partner account, including access settings and exclusions.

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

# get_connection_preferences method definition

def get_connection_preferences(
    self,
    *,
    Catalog: str,
) -> GetConnectionPreferencesResponseTypeDef:  # (1)
    ...

1. See GetConnectionPreferencesResponseTypeDef

# get_connection_preferences method usage example with argument unpacking

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

parent.get_connection_preferences(**kwargs)

1. See GetConnectionPreferencesRequestTypeDef

get_partner

Retrieves detailed information about a specific partner account.

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

# get_partner method definition

def get_partner(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetPartnerResponseTypeDef:  # (1)
    ...

1. See GetPartnerResponseTypeDef

# get_partner method usage example with argument unpacking

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

parent.get_partner(**kwargs)

1. See GetPartnerRequestTypeDef

get_profile_update_task

Retrieves information about a specific profile update task.

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

# get_profile_update_task method definition

def get_profile_update_task(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetProfileUpdateTaskResponseTypeDef:  # (1)
    ...

1. See GetProfileUpdateTaskResponseTypeDef

# get_profile_update_task method usage example with argument unpacking

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

parent.get_profile_update_task(**kwargs)

1. See GetProfileUpdateTaskRequestTypeDef

get_profile_visibility

Retrieves the visibility settings for a partner profile, determining who can see the profile information.

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

# get_profile_visibility method definition

def get_profile_visibility(
    self,
    *,
    Catalog: str,
    Identifier: str,
) -> GetProfileVisibilityResponseTypeDef:  # (1)
    ...

1. See GetProfileVisibilityResponseTypeDef

# get_profile_visibility method usage example with argument unpacking

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

parent.get_profile_visibility(**kwargs)

1. See GetProfileVisibilityRequestTypeDef

list_connection_invitations

Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.

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

# list_connection_invitations method definition

def list_connection_invitations(
    self,
    *,
    Catalog: str,
    NextToken: str = ...,
    ConnectionType: ConnectionTypeType = ...,  # (1)
    MaxResults: int = ...,
    OtherParticipantIdentifiers: Sequence[str] = ...,
    ParticipantType: ParticipantTypeType = ...,  # (2)
    Status: InvitationStatusType = ...,  # (3)
) -> ListConnectionInvitationsResponseTypeDef:  # (4)
    ...

1. See ConnectionTypeType
2. See ParticipantTypeType
3. See InvitationStatusType
4. See ListConnectionInvitationsResponseTypeDef

# list_connection_invitations method usage example with argument unpacking

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

parent.list_connection_invitations(**kwargs)

1. See ListConnectionInvitationsRequestTypeDef

list_connections

Lists active connections for the partner account, with optional filtering by connection type and participant.

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

# list_connections method definition

def list_connections(
    self,
    *,
    Catalog: str,
    NextToken: str = ...,
    ConnectionType: str = ...,
    MaxResults: int = ...,
    OtherParticipantIdentifiers: Sequence[str] = ...,
) -> ListConnectionsResponseTypeDef:  # (1)
    ...

1. See ListConnectionsResponseTypeDef

# list_connections method usage example with argument unpacking

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

parent.list_connections(**kwargs)

1. See ListConnectionsRequestTypeDef

list_partners

Lists partner accounts in the catalog, providing a summary view of all partners.

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

# list_partners method definition

def list_partners(
    self,
    *,
    Catalog: str,
    NextToken: str = ...,
) -> ListPartnersResponseTypeDef:  # (1)
    ...

1. See ListPartnersResponseTypeDef

# list_partners method usage example with argument unpacking

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

parent.list_partners(**kwargs)

1. See ListPartnersRequestTypeDef

list_tags_for_resource

Lists all tags associated with a specific AWS Partner Central Account resource.

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

put_alliance_lead_contact

Creates or updates the alliance lead contact information for a partner account.

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

# put_alliance_lead_contact method definition

def put_alliance_lead_contact(
    self,
    *,
    Catalog: str,
    Identifier: str,
    AllianceLeadContact: AllianceLeadContactTypeDef,  # (1)
    EmailVerificationCode: str = ...,
) -> PutAllianceLeadContactResponseTypeDef:  # (2)
    ...

1. See AllianceLeadContactTypeDef
2. See PutAllianceLeadContactResponseTypeDef

# put_alliance_lead_contact method usage example with argument unpacking

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

parent.put_alliance_lead_contact(**kwargs)

1. See PutAllianceLeadContactRequestTypeDef

put_profile_visibility

Sets the visibility level for a partner profile, controlling who can view the profile information.

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

# put_profile_visibility method definition

def put_profile_visibility(
    self,
    *,
    Catalog: str,
    Identifier: str,
    Visibility: ProfileVisibilityType,  # (1)
) -> PutProfileVisibilityResponseTypeDef:  # (2)
    ...

1. See ProfileVisibilityType
2. See PutProfileVisibilityResponseTypeDef

# put_profile_visibility method usage example with argument unpacking

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

parent.put_profile_visibility(**kwargs)

1. See PutProfileVisibilityRequestTypeDef

reject_connection_invitation

Rejects a connection invitation from another partner, declining the partnership request.

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

# reject_connection_invitation method definition

def reject_connection_invitation(
    self,
    *,
    Catalog: str,
    Identifier: str,
    ClientToken: str,
    Reason: str = ...,
) -> RejectConnectionInvitationResponseTypeDef:  # (1)
    ...

1. See RejectConnectionInvitationResponseTypeDef

# reject_connection_invitation method usage example with argument unpacking

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

parent.reject_connection_invitation(**kwargs)

1. See RejectConnectionInvitationRequestTypeDef

send_email_verification_code

Sends an email verification code to the specified email address for account verification purposes.

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

# send_email_verification_code method definition

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

# send_email_verification_code method usage example with argument unpacking

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

parent.send_email_verification_code(**kwargs)

1. See SendEmailVerificationCodeRequestTypeDef

start_profile_update_task

Initiates a profile update task to modify partner profile information asynchronously.

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

# start_profile_update_task method definition

def start_profile_update_task(
    self,
    *,
    Catalog: str,
    Identifier: str,
    TaskDetails: TaskDetailsUnionTypeDef,  # (1)
    ClientToken: str = ...,
) -> StartProfileUpdateTaskResponseTypeDef:  # (2)
    ...

1. See TaskDetailsUnionTypeDef
2. See StartProfileUpdateTaskResponseTypeDef

# start_profile_update_task method usage example with argument unpacking

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

parent.start_profile_update_task(**kwargs)

1. See StartProfileUpdateTaskRequestTypeDef

tag_resource

Adds or updates tags for a specified AWS Partner Central Account resource.

Type annotations and code completion for boto3.client("partnercentral-account").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 an AWS Partner Central Account resource.

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

Updates the connection preferences for a partner account, modifying access settings and exclusions.

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

# update_connection_preferences method definition

def update_connection_preferences(
    self,
    *,
    Catalog: str,
    Revision: int,
    AccessType: AccessTypeType,  # (1)
    ExcludedParticipantIdentifiers: Sequence[str] = ...,
) -> UpdateConnectionPreferencesResponseTypeDef:  # (2)
    ...

1. See AccessTypeType
2. See UpdateConnectionPreferencesResponseTypeDef

# update_connection_preferences method usage example with argument unpacking

kwargs: UpdateConnectionPreferencesRequestTypeDef = {  # (1)
    "Catalog": ...,
    "Revision": ...,
    "AccessType": ...,
}

parent.update_connection_preferences(**kwargs)

1. See UpdateConnectionPreferencesRequestTypeDef

get_paginator

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

• client.get_paginator("list_connection_invitations") -> ListConnectionInvitationsPaginator
• client.get_paginator("list_connections") -> ListConnectionsPaginator
• client.get_paginator("list_partners") -> ListPartnersPaginator