create_connection_invitation
async
¶
create_connection_invitation(
catalog: Catalog,
client_token: ClientToken,
connection_type: ConnectionType,
email: Email,
message: UnicodeStringIncludingNewLine,
name: SensitiveUnicodeString,
receiver_identifier: ParticipantIdentifier,
*,
config_overrides: Optional[AsyncPartnerCentralAccountClientConfig] = None,
) -> CreateConnectionInvitationResponse
Creates a new connection invitation to establish a partnership with another organization.
Parameters:
-
catalog(Catalog) –The catalog identifier where the connection invitation will be created.
-
client_token(ClientToken) –A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
connection_type(ConnectionType) –The type of connection being requested (e.g., reseller, distributor, technology partner).
-
email(Email) –The email address of the person to send the connection invitation to.
-
message(UnicodeStringIncludingNewLine) –A custom message to include with the connection invitation.
-
name(SensitiveUnicodeString) –The name of the person sending the connection invitation.
-
receiver_identifier(ParticipantIdentifier) –The identifier of the organization or partner to invite for connection.
Raises:
-
AccessDeniedException–The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
-
ConflictException–The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.
-
InternalServerException–An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
-
ResourceNotFoundException–The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
-
ServiceQuotaExceededException–The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.
-
ThrottlingException–The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.
-
ValidationException–The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_partnercentral_account/_services/async_partner_central_account.py
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 | |