PartnerCentralChannelAPIClient

Index > PartnerCentralChannelAPI > PartnerCentralChannelAPIClient

Auto-generated documentation for PartnerCentralChannelAPI type annotations stubs module types-boto3-partnercentral-channel.

PartnerCentralChannelAPIClient

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

# PartnerCentralChannelAPIClient usage example

from boto3.session import Session
from types_boto3_partnercentral_channel.client import PartnerCentralChannelAPIClient

def get_partnercentral-channel_client() -> PartnerCentralChannelAPIClient:
    return Session().client("partnercentral-channel")

Exceptions

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

# Exceptions.exceptions usage example

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

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

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

Methods

can_paginate

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

Accepts a pending channel handshake request from another AWS account.

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

# accept_channel_handshake method definition

def accept_channel_handshake(
    self,
    *,
    catalog: str,
    identifier: str,
) -> AcceptChannelHandshakeResponseTypeDef:  # (1)
    ...

1. See AcceptChannelHandshakeResponseTypeDef

# accept_channel_handshake method usage example with argument unpacking

kwargs: AcceptChannelHandshakeRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
}

parent.accept_channel_handshake(**kwargs)

1. See AcceptChannelHandshakeRequestTypeDef

cancel_channel_handshake

Cancels a pending channel handshake request.

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

# cancel_channel_handshake method definition

def cancel_channel_handshake(
    self,
    *,
    catalog: str,
    identifier: str,
) -> CancelChannelHandshakeResponseTypeDef:  # (1)
    ...

1. See CancelChannelHandshakeResponseTypeDef

# cancel_channel_handshake method usage example with argument unpacking

kwargs: CancelChannelHandshakeRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
}

parent.cancel_channel_handshake(**kwargs)

1. See CancelChannelHandshakeRequestTypeDef

create_channel_handshake

Creates a new channel handshake request to establish a partnership with another AWS account.

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

# create_channel_handshake method definition

def create_channel_handshake(
    self,
    *,
    handshakeType: HandshakeTypeType,  # (1)
    catalog: str,
    associatedResourceIdentifier: str,
    payload: ChannelHandshakePayloadTypeDef = ...,  # (2)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateChannelHandshakeResponseTypeDef:  # (4)
    ...

1. See HandshakeTypeType
2. See ChannelHandshakePayloadTypeDef
3. See Sequence[TagTypeDef]
4. See CreateChannelHandshakeResponseTypeDef

# create_channel_handshake method usage example with argument unpacking

kwargs: CreateChannelHandshakeRequestTypeDef = {  # (1)
    "handshakeType": ...,
    "catalog": ...,
    "associatedResourceIdentifier": ...,
}

parent.create_channel_handshake(**kwargs)

1. See CreateChannelHandshakeRequestTypeDef

create_program_management_account

Creates a new program management account for managing partner relationships.

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

# create_program_management_account method definition

def create_program_management_account(
    self,
    *,
    catalog: str,
    program: ProgramType,  # (1)
    displayName: str,
    accountId: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateProgramManagementAccountResponseTypeDef:  # (3)
    ...

1. See ProgramType
2. See Sequence[TagTypeDef]
3. See CreateProgramManagementAccountResponseTypeDef

# create_program_management_account method usage example with argument unpacking

kwargs: CreateProgramManagementAccountRequestTypeDef = {  # (1)
    "catalog": ...,
    "program": ...,
    "displayName": ...,
    "accountId": ...,
}

parent.create_program_management_account(**kwargs)

1. See CreateProgramManagementAccountRequestTypeDef

create_relationship

Creates a new partner relationship between accounts.

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

# create_relationship method definition

def create_relationship(
    self,
    *,
    catalog: str,
    associationType: AssociationTypeType,  # (1)
    programManagementAccountIdentifier: str,
    associatedAccountId: str,
    displayName: str,
    sector: SectorType,  # (2)
    resaleAccountModel: ResaleAccountModelType = ...,  # (3)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (4)
    requestedSupportPlan: SupportPlanTypeDef = ...,  # (5)
) -> CreateRelationshipResponseTypeDef:  # (6)
    ...

1. See AssociationTypeType
2. See SectorType
3. See ResaleAccountModelType
4. See Sequence[TagTypeDef]
5. See SupportPlanTypeDef
6. See CreateRelationshipResponseTypeDef

# create_relationship method usage example with argument unpacking

kwargs: CreateRelationshipRequestTypeDef = {  # (1)
    "catalog": ...,
    "associationType": ...,
    "programManagementAccountIdentifier": ...,
    "associatedAccountId": ...,
    "displayName": ...,
    "sector": ...,
}

parent.create_relationship(**kwargs)

1. See CreateRelationshipRequestTypeDef

delete_program_management_account

Deletes a program management account.

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

# delete_program_management_account method definition

def delete_program_management_account(
    self,
    *,
    catalog: str,
    identifier: str,
    clientToken: str = ...,
) -> dict[str, Any]:
    ...

# delete_program_management_account method usage example with argument unpacking

kwargs: DeleteProgramManagementAccountRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
}

parent.delete_program_management_account(**kwargs)

1. See DeleteProgramManagementAccountRequestTypeDef

delete_relationship

Deletes a partner relationship.

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

# delete_relationship method definition

def delete_relationship(
    self,
    *,
    catalog: str,
    identifier: str,
    programManagementAccountIdentifier: str,
    clientToken: str = ...,
) -> dict[str, Any]:
    ...

# delete_relationship method usage example with argument unpacking

kwargs: DeleteRelationshipRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
    "programManagementAccountIdentifier": ...,
}

parent.delete_relationship(**kwargs)

1. See DeleteRelationshipRequestTypeDef

get_relationship

Retrieves details of a specific partner relationship.

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

# get_relationship method definition

def get_relationship(
    self,
    *,
    catalog: str,
    programManagementAccountIdentifier: str,
    identifier: str,
) -> GetRelationshipResponseTypeDef:  # (1)
    ...

1. See GetRelationshipResponseTypeDef

# get_relationship method usage example with argument unpacking

kwargs: GetRelationshipRequestTypeDef = {  # (1)
    "catalog": ...,
    "programManagementAccountIdentifier": ...,
    "identifier": ...,
}

parent.get_relationship(**kwargs)

1. See GetRelationshipRequestTypeDef

list_channel_handshakes

Lists channel handshakes based on specified criteria.

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

# list_channel_handshakes method definition

def list_channel_handshakes(
    self,
    *,
    handshakeType: HandshakeTypeType,  # (1)
    catalog: str,
    participantType: ParticipantTypeType,  # (2)
    maxResults: int = ...,
    statuses: Sequence[HandshakeStatusType] = ...,  # (3)
    associatedResourceIdentifiers: Sequence[str] = ...,
    handshakeTypeFilters: ListChannelHandshakesTypeFiltersTypeDef = ...,  # (4)
    handshakeTypeSort: ListChannelHandshakesTypeSortTypeDef = ...,  # (5)
    nextToken: str = ...,
) -> ListChannelHandshakesResponseTypeDef:  # (6)
    ...

1. See HandshakeTypeType
2. See ParticipantTypeType
3. See Sequence[HandshakeStatusType]
4. See ListChannelHandshakesTypeFiltersTypeDef
5. See ListChannelHandshakesTypeSortTypeDef
6. See ListChannelHandshakesResponseTypeDef

# list_channel_handshakes method usage example with argument unpacking

kwargs: ListChannelHandshakesRequestTypeDef = {  # (1)
    "handshakeType": ...,
    "catalog": ...,
    "participantType": ...,
}

parent.list_channel_handshakes(**kwargs)

1. See ListChannelHandshakesRequestTypeDef

list_program_management_accounts

Lists program management accounts based on specified criteria.

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

# list_program_management_accounts method definition

def list_program_management_accounts(
    self,
    *,
    catalog: str,
    maxResults: int = ...,
    displayNames: Sequence[str] = ...,
    programs: Sequence[ProgramType] = ...,  # (1)
    accountIds: Sequence[str] = ...,
    statuses: Sequence[ProgramManagementAccountStatusType] = ...,  # (2)
    sort: ListProgramManagementAccountsSortBaseTypeDef = ...,  # (3)
    nextToken: str = ...,
) -> ListProgramManagementAccountsResponseTypeDef:  # (4)
    ...

1. See Sequence[ProgramType]
2. See Sequence[ProgramManagementAccountStatusType]
3. See ListProgramManagementAccountsSortBaseTypeDef
4. See ListProgramManagementAccountsResponseTypeDef

# list_program_management_accounts method usage example with argument unpacking

kwargs: ListProgramManagementAccountsRequestTypeDef = {  # (1)
    "catalog": ...,
}

parent.list_program_management_accounts(**kwargs)

1. See ListProgramManagementAccountsRequestTypeDef

list_relationships

Lists partner relationships based on specified criteria.

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

# list_relationships method definition

def list_relationships(
    self,
    *,
    catalog: str,
    maxResults: int = ...,
    associatedAccountIds: Sequence[str] = ...,
    associationTypes: Sequence[AssociationTypeType] = ...,  # (1)
    displayNames: Sequence[str] = ...,
    programManagementAccountIdentifiers: Sequence[str] = ...,
    sort: ListRelationshipsSortBaseTypeDef = ...,  # (2)
    nextToken: str = ...,
) -> ListRelationshipsResponseTypeDef:  # (3)
    ...

1. See Sequence[AssociationTypeType]
2. See ListRelationshipsSortBaseTypeDef
3. See ListRelationshipsResponseTypeDef

# list_relationships method usage example with argument unpacking

kwargs: ListRelationshipsRequestTypeDef = {  # (1)
    "catalog": ...,
}

parent.list_relationships(**kwargs)

1. See ListRelationshipsRequestTypeDef

list_tags_for_resource

Lists tags associated with a specific resource.

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

reject_channel_handshake

Rejects a pending channel handshake request.

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

# reject_channel_handshake method definition

def reject_channel_handshake(
    self,
    *,
    catalog: str,
    identifier: str,
) -> RejectChannelHandshakeResponseTypeDef:  # (1)
    ...

1. See RejectChannelHandshakeResponseTypeDef

# reject_channel_handshake method usage example with argument unpacking

kwargs: RejectChannelHandshakeRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
}

parent.reject_channel_handshake(**kwargs)

1. See RejectChannelHandshakeRequestTypeDef

tag_resource

Adds or updates tags for a specified resource.

Type annotations and code completion for boto3.client("partnercentral-channel").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 tags from a specified resource.

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

Updates the properties of a program management account.

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

# update_program_management_account method definition

def update_program_management_account(
    self,
    *,
    catalog: str,
    identifier: str,
    revision: str = ...,
    displayName: str = ...,
) -> UpdateProgramManagementAccountResponseTypeDef:  # (1)
    ...

1. See UpdateProgramManagementAccountResponseTypeDef

# update_program_management_account method usage example with argument unpacking

kwargs: UpdateProgramManagementAccountRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
}

parent.update_program_management_account(**kwargs)

1. See UpdateProgramManagementAccountRequestTypeDef

update_relationship

Updates the properties of a partner relationship.

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

# update_relationship method definition

def update_relationship(
    self,
    *,
    catalog: str,
    identifier: str,
    programManagementAccountIdentifier: str,
    revision: str = ...,
    displayName: str = ...,
    requestedSupportPlan: SupportPlanTypeDef = ...,  # (1)
) -> UpdateRelationshipResponseTypeDef:  # (2)
    ...

1. See SupportPlanTypeDef
2. See UpdateRelationshipResponseTypeDef

# update_relationship method usage example with argument unpacking

kwargs: UpdateRelationshipRequestTypeDef = {  # (1)
    "catalog": ...,
    "identifier": ...,
    "programManagementAccountIdentifier": ...,
}

parent.update_relationship(**kwargs)

1. See UpdateRelationshipRequestTypeDef

get_paginator

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

• client.get_paginator("list_channel_handshakes") -> ListChannelHandshakesPaginator
• client.get_paginator("list_program_management_accounts") -> ListProgramManagementAccountsPaginator
• client.get_paginator("list_relationships") -> ListRelationshipsPaginator