SDK for PHP V3
Partner Central Account API 2025-04-04
- Client: Aws\PartnerCentralAccount\PartnerCentralAccountClient
- Service ID: partnercentral-account
- Version: 2025-04-04
This page describes the parameters and results for the operations of the Partner Central Account API (2025-04-04), and shows how to use the Aws\PartnerCentralAccount\PartnerCentralAccountClient object to call the described operations. This documentation is specific to the 2025-04-04 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcceptConnectionInvitation ( array $params = [] )
- Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.
- AssociateAwsTrainingCertificationEmailDomain ( array $params = [] )
- Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.
- CancelConnection ( array $params = [] )
- Cancels an existing connection between partners, terminating the partnership relationship.
- CancelConnectionInvitation ( array $params = [] )
- Cancels a pending connection invitation before it has been accepted or rejected.
- CancelProfileUpdateTask ( array $params = [] )
- Cancels an in-progress profile update task, stopping any pending changes to the partner profile.
- CreateConnectionInvitation ( array $params = [] )
- Creates a new connection invitation to establish a partnership with another organization.
- CreatePartner ( array $params = [] )
- Creates a new partner account in the AWS Partner Network with the specified details and configuration.
- DisassociateAwsTrainingCertificationEmailDomain ( array $params = [] )
- Removes the association between an email domain and AWS training and certification for the partner account.
- GetAllianceLeadContact ( array $params = [] )
- Retrieves the alliance lead contact information for a partner account.
- GetConnection ( array $params = [] )
- Retrieves detailed information about a specific connection between partners.
- GetConnectionInvitation ( array $params = [] )
- Retrieves detailed information about a specific connection invitation.
- GetConnectionPreferences ( array $params = [] )
- Retrieves the connection preferences for a partner account, including access settings and exclusions.
- GetPartner ( array $params = [] )
- Retrieves detailed information about a specific partner account.
- GetProfileUpdateTask ( array $params = [] )
- Retrieves information about a specific profile update task.
- GetProfileVisibility ( array $params = [] )
- Retrieves the visibility settings for a partner profile, determining who can see the profile information.
- ListConnectionInvitations ( array $params = [] )
- Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
- ListConnections ( array $params = [] )
- Lists active connections for the partner account, with optional filtering by connection type and participant.
- ListPartners ( array $params = [] )
- Lists partner accounts in the catalog, providing a summary view of all partners.
- ListTagsForResource ( array $params = [] )
- Lists all tags associated with a specific AWS Partner Central Account resource.
- PutAllianceLeadContact ( array $params = [] )
- Creates or updates the alliance lead contact information for a partner account.
- PutProfileVisibility ( array $params = [] )
- Sets the visibility level for a partner profile, controlling who can view the profile information.
- RejectConnectionInvitation ( array $params = [] )
- Rejects a connection invitation from another partner, declining the partnership request.
- SendEmailVerificationCode ( array $params = [] )
- Sends an email verification code to the specified email address for account verification purposes.
- StartProfileUpdateTask ( array $params = [] )
- Initiates a profile update task to modify partner profile information asynchronously.
- TagResource ( array $params = [] )
- Adds or updates tags for a specified AWS Partner Central Account resource.
- UntagResource ( array $params = [] )
- Removes specified tags from an AWS Partner Central Account resource.
- UpdateConnectionPreferences ( array $params = [] )
- Updates the connection preferences for a partner account, modifying access settings and exclusions.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AcceptConnectionInvitation
$result = $client->acceptConnectionInvitation([/* ... */]); $promise = $client->acceptConnectionInvitationAsync([/* ... */]);
Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.
Parameter Syntax
$result = $client->acceptConnectionInvitation([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- ClientToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation to accept.
Result Syntax
[
'Connection' => [
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionTypes' => [
'<ConnectionType>' => [
'CanceledAt' => <DateTime>,
'CanceledBy' => '<string>',
'CreatedAt' => <DateTime>,
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipant' => [
'Account' => [
'Name' => '<string>',
],
'PartnerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
'SellerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
],
'Status' => 'ACTIVE|CANCELED',
],
// ...
],
'Id' => '<string>',
'OtherParticipantAccountId' => '<string>',
'UpdatedAt' => <DateTime>,
],
]
Result Details
Members
- Connection
-
- Required: Yes
- Type: Connection structure
The details of the accepted connection between the two partners.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
AssociateAwsTrainingCertificationEmailDomain
$result = $client->associateAwsTrainingCertificationEmailDomain([/* ... */]); $promise = $client->associateAwsTrainingCertificationEmailDomainAsync([/* ... */]);
Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.
Parameter Syntax
$result = $client->associateAwsTrainingCertificationEmailDomain([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'Email' => '<string>', // REQUIRED
'EmailVerificationCode' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
- Required: Yes
- Type: string
The email address used to verify domain ownership for AWS training and certification association.
- EmailVerificationCode
-
- Required: Yes
- Type: string
The verification code sent to the email address to confirm domain ownership.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- 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.
- 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.
- 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.
CancelConnection
$result = $client->cancelConnection([/* ... */]); $promise = $client->cancelConnectionAsync([/* ... */]);
Cancels an existing connection between partners, terminating the partnership relationship.
Parameter Syntax
$result = $client->cancelConnection([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY', // REQUIRED
'Identifier' => '<string>', // REQUIRED
'Reason' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection exists.
- ClientToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection to cancel (e.g., reseller, distributor, technology partner).
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection to cancel.
- Reason
-
- Required: Yes
- Type: string
The reason for canceling the connection, providing context for the termination.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionTypes' => [
'<ConnectionType>' => [
'CanceledAt' => <DateTime>,
'CanceledBy' => '<string>',
'CreatedAt' => <DateTime>,
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipant' => [
'Account' => [
'Name' => '<string>',
],
'PartnerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
'SellerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
],
'Status' => 'ACTIVE|CANCELED',
],
// ...
],
'Id' => '<string>',
'OtherParticipantAccountId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the canceled connection.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection was canceled.
- ConnectionTypes
-
- Required: Yes
- Type: Associative array of custom strings keys (ConnectionType) to ConnectionTypeDetail structures
The list of connection types that were active before cancellation.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the canceled connection.
- OtherParticipantAccountId
-
- Required: Yes
- Type: string
The AWS account ID of the other participant in the canceled connection.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection was last updated (canceled).
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
CancelConnectionInvitation
$result = $client->cancelConnectionInvitation([/* ... */]); $promise = $client->cancelConnectionInvitationAsync([/* ... */]);
Cancels a pending connection invitation before it has been accepted or rejected.
Parameter Syntax
$result = $client->cancelConnectionInvitation([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- ClientToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation to cancel.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionId' => '<string>',
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'CreatedAt' => <DateTime>,
'ExpiresAt' => <DateTime>,
'Id' => '<string>',
'InvitationMessage' => '<string>',
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipantIdentifier' => '<string>',
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the canceled connection invitation.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation was canceled.
- ConnectionId
-
- Type: string
The identifier of the connection associated with the canceled invitation.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection that was being invited for.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was originally created.
- ExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation would have expired if not canceled.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the canceled connection invitation.
- InvitationMessage
-
- Required: Yes
- Type: string
The message that was included with the original connection invitation.
- InviterEmail
-
- Required: Yes
- Type: string
The email address of the person who sent the connection invitation.
- InviterName
-
- Required: Yes
- Type: string
The name of the person who sent the connection invitation.
- OtherParticipantIdentifier
-
- Required: Yes
- Type: string
The identifier of the other participant who was invited to connect.
- ParticipantType
-
- Required: Yes
- Type: string
The type of participant (inviter or invitee) in the connection invitation.
- Status
-
- Required: Yes
- Type: string
The current status of the connection invitation (canceled).
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was last updated (canceled).
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
CancelProfileUpdateTask
$result = $client->cancelProfileUpdateTask([/* ... */]); $promise = $client->cancelProfileUpdateTaskAsync([/* ... */]);
Cancels an in-progress profile update task, stopping any pending changes to the partner profile.
Parameter Syntax
$result = $client->cancelProfileUpdateTask([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'Identifier' => '<string>', // REQUIRED
'TaskId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- TaskId
-
- Required: Yes
- Type: string
The unique identifier of the profile update task to cancel.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'EndedAt' => <DateTime>,
'ErrorDetailList' => [
[
'Locale' => '<string>',
'Message' => '<string>',
'Reason' => 'INVALID_CONTENT|DUPLICATE_PROFILE|INVALID_LOGO|INVALID_LOGO_URL|INVALID_LOGO_FILE|INVALID_LOGO_SIZE|INVALID_WEBSITE_URL',
],
// ...
],
'Id' => '<string>',
'StartedAt' => <DateTime>,
'Status' => 'IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
'TaskDetails' => [
'Description' => '<string>',
'DisplayName' => '<string>',
'IndustrySegments' => ['<string>', ...],
'LocalizedContents' => [
[
'Description' => '<string>',
'DisplayName' => '<string>',
'Locale' => '<string>',
'LogoUrl' => '<string>',
'WebsiteUrl' => '<string>',
],
// ...
],
'LogoUrl' => '<string>',
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES',
'TranslationSourceLocale' => '<string>',
'WebsiteUrl' => '<string>',
],
'TaskId' => '<string>',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the canceled profile update task.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task was ended (canceled).
- ErrorDetailList
-
- Type: Array of ErrorDetail structures
A list of error details if any errors occurred during the profile update task.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task was started.
- Status
-
- Required: Yes
- Type: string
The current status of the profile update task (canceled).
- TaskDetails
-
- Required: Yes
- Type: TaskDetails structure
The details of the profile update task that was canceled.
- TaskId
-
- Required: Yes
- Type: string
The unique identifier of the canceled profile update task.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- 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.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
CreateConnectionInvitation
$result = $client->createConnectionInvitation([/* ... */]); $promise = $client->createConnectionInvitationAsync([/* ... */]);
Creates a new connection invitation to establish a partnership with another organization.
Parameter Syntax
$result = $client->createConnectionInvitation([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY', // REQUIRED
'Email' => '<string>', // REQUIRED
'Message' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'ReceiverIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation will be created.
- ClientToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection being requested (e.g., reseller, distributor, technology partner).
-
- Required: Yes
- Type: string
The email address of the person to send the connection invitation to.
- Message
-
- Required: Yes
- Type: string
A custom message to include with the connection invitation.
- Name
-
- Required: Yes
- Type: string
The name of the person sending the connection invitation.
- ReceiverIdentifier
-
- Required: Yes
- Type: string
The identifier of the organization or partner to invite for connection.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionId' => '<string>',
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'CreatedAt' => <DateTime>,
'ExpiresAt' => <DateTime>,
'Id' => '<string>',
'InvitationMessage' => '<string>',
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipantIdentifier' => '<string>',
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created connection invitation.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation was created.
- ConnectionId
-
- Type: string
The identifier of the connection associated with this invitation.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection being requested in the invitation.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was created.
- ExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation will expire if not responded to.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the created connection invitation.
- InvitationMessage
-
- Required: Yes
- Type: string
The custom message included with the connection invitation.
- InviterEmail
-
- Required: Yes
- Type: string
The email address of the person who sent the connection invitation.
- InviterName
-
- Required: Yes
- Type: string
The name of the person who sent the connection invitation.
- OtherParticipantIdentifier
-
- Required: Yes
- Type: string
The identifier of the organization or partner being invited.
- ParticipantType
-
- Required: Yes
- Type: string
The type of participant (inviter or invitee) in the connection invitation.
- Status
-
- Required: Yes
- Type: string
The current status of the connection invitation (pending, accepted, rejected, etc.).
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was last updated.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
CreatePartner
$result = $client->createPartner([/* ... */]); $promise = $client->createPartnerAsync([/* ... */]);
Creates a new partner account in the AWS Partner Network with the specified details and configuration.
Parameter Syntax
$result = $client->createPartner([
'AllianceLeadContact' => [ // REQUIRED
'BusinessTitle' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'FirstName' => '<string>', // REQUIRED
'LastName' => '<string>', // REQUIRED
],
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'EmailVerificationCode' => '<string>', // REQUIRED
'LegalName' => '<string>', // REQUIRED
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AllianceLeadContact
-
- Required: Yes
- Type: AllianceLeadContact structure
The primary contact person for alliance and partnership matters.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the partner account will be created.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- EmailVerificationCode
-
- Required: Yes
- Type: string
The verification code sent to the alliance lead contact's email to confirm account creation.
- LegalName
-
- Required: Yes
- Type: string
The legal name of the organization becoming a partner.
- PrimarySolutionType
-
- Required: Yes
- Type: string
The primary type of solution or service the partner provides (e.g., consulting, software, managed services).
- Tags
-
- Type: Array of Tag structures
A list of tags to associate with the partner account for organization and billing purposes.
Result Syntax
[
'AllianceLeadContact' => [
'BusinessTitle' => '<string>',
'Email' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
],
'Arn' => '<string>',
'AwsTrainingCertificationEmailDomains' => [
[
'DomainName' => '<string>',
'RegisteredAt' => <DateTime>,
],
// ...
],
'Catalog' => '<string>',
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'LegalName' => '<string>',
'Profile' => [
'Description' => '<string>',
'DisplayName' => '<string>',
'IndustrySegments' => ['<string>', ...],
'LocalizedContents' => [
[
'Description' => '<string>',
'DisplayName' => '<string>',
'Locale' => '<string>',
'LogoUrl' => '<string>',
'WebsiteUrl' => '<string>',
],
// ...
],
'LogoUrl' => '<string>',
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES',
'ProfileId' => '<string>',
'TranslationSourceLocale' => '<string>',
'WebsiteUrl' => '<string>',
],
]
Result Details
Members
- AllianceLeadContact
-
- Required: Yes
- Type: AllianceLeadContact structure
The alliance lead contact information for the partner account.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created partner account.
- AwsTrainingCertificationEmailDomains
-
- Type: Array of PartnerDomain structures
The list of verified email domains associated with AWS training and certification credentials for the partner organization.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the partner account was created.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the partner account was created.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the created partner account.
- LegalName
-
- Required: Yes
- Type: string
The legal name of the partner organization.
- Profile
-
- Required: Yes
- Type: PartnerProfile structure
The partner profile information including display name, description, and other public details.
Errors
- 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.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
DisassociateAwsTrainingCertificationEmailDomain
$result = $client->disassociateAwsTrainingCertificationEmailDomain([/* ... */]); $promise = $client->disassociateAwsTrainingCertificationEmailDomainAsync([/* ... */]);
Removes the association between an email domain and AWS training and certification for the partner account.
Parameter Syntax
$result = $client->disassociateAwsTrainingCertificationEmailDomain([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'DomainName' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- DomainName
-
- Required: Yes
- Type: string
The domain name to disassociate from AWS training and certification.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- 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.
- 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.
GetAllianceLeadContact
$result = $client->getAllianceLeadContact([/* ... */]); $promise = $client->getAllianceLeadContactAsync([/* ... */]);
Retrieves the alliance lead contact information for a partner account.
Parameter Syntax
$result = $client->getAllianceLeadContact([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[
'AllianceLeadContact' => [
'BusinessTitle' => '<string>',
'Email' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
],
'Arn' => '<string>',
'Catalog' => '<string>',
'Id' => '<string>',
]
Result Details
Members
- AllianceLeadContact
-
- Required: Yes
- Type: AllianceLeadContact structure
The alliance lead contact information including name, email, and business title.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetConnection
$result = $client->getConnection([/* ... */]); $promise = $client->getConnectionAsync([/* ... */]);
Retrieves detailed information about a specific connection between partners.
Parameter Syntax
$result = $client->getConnection([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection exists.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection to retrieve.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionTypes' => [
'<ConnectionType>' => [
'CanceledAt' => <DateTime>,
'CanceledBy' => '<string>',
'CreatedAt' => <DateTime>,
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipant' => [
'Account' => [
'Name' => '<string>',
],
'PartnerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
'SellerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
],
'Status' => 'ACTIVE|CANCELED',
],
// ...
],
'Id' => '<string>',
'OtherParticipantAccountId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection exists.
- ConnectionTypes
-
- Required: Yes
- Type: Associative array of custom strings keys (ConnectionType) to ConnectionTypeDetail structures
The list of connection types active between the partners.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the connection.
- OtherParticipantAccountId
-
- Required: Yes
- Type: string
The AWS account ID of the other participant in the connection.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection was last updated.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetConnectionInvitation
$result = $client->getConnectionInvitation([/* ... */]); $promise = $client->getConnectionInvitationAsync([/* ... */]);
Retrieves detailed information about a specific connection invitation.
Parameter Syntax
$result = $client->getConnectionInvitation([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation to retrieve.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionId' => '<string>',
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'CreatedAt' => <DateTime>,
'ExpiresAt' => <DateTime>,
'Id' => '<string>',
'InvitationMessage' => '<string>',
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipantIdentifier' => '<string>',
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection invitation.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- ConnectionId
-
- Type: string
The identifier of the connection associated with this invitation.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection being requested in the invitation.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was created.
- ExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation will expire.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation.
- InvitationMessage
-
- Required: Yes
- Type: string
The custom message included with the connection invitation.
- InviterEmail
-
- Required: Yes
- Type: string
The email address of the person who sent the connection invitation.
- InviterName
-
- Required: Yes
- Type: string
The name of the person who sent the connection invitation.
- OtherParticipantIdentifier
-
- Required: Yes
- Type: string
The identifier of the other participant in the connection invitation.
- ParticipantType
-
- Required: Yes
- Type: string
The type of participant (inviter or invitee) in the connection invitation.
- Status
-
- Required: Yes
- Type: string
The current status of the connection invitation.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was last updated.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetConnectionPreferences
$result = $client->getConnectionPreferences([/* ... */]); $promise = $client->getConnectionPreferencesAsync([/* ... */]);
Retrieves the connection preferences for a partner account, including access settings and exclusions.
Parameter Syntax
$result = $client->getConnectionPreferences([
'Catalog' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
Result Syntax
[
'AccessType' => 'ALLOW_ALL|DENY_ALL|ALLOW_BY_DEFAULT_DENY_SOME',
'Arn' => '<string>',
'Catalog' => '<string>',
'ExcludedParticipantIds' => ['<string>', ...],
'Revision' => <integer>,
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- AccessType
-
- Required: Yes
- Type: string
The access type setting for connections (e.g., open, restricted, invitation-only).
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection preferences.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ExcludedParticipantIds
-
- Type: Array of strings
A list of participant IDs that are excluded from connection requests or interactions.
- Revision
-
- Required: Yes
- Type: long (int|float)
The revision number of the connection preferences for optimistic locking.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection preferences were last updated.
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetPartner
$result = $client->getPartner([/* ... */]); $promise = $client->getPartnerAsync([/* ... */]);
Retrieves detailed information about a specific partner account.
Parameter Syntax
$result = $client->getPartner([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account to retrieve.
Result Syntax
[
'Arn' => '<string>',
'AwsTrainingCertificationEmailDomains' => [
[
'DomainName' => '<string>',
'RegisteredAt' => <DateTime>,
],
// ...
],
'Catalog' => '<string>',
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'LegalName' => '<string>',
'Profile' => [
'Description' => '<string>',
'DisplayName' => '<string>',
'IndustrySegments' => ['<string>', ...],
'LocalizedContents' => [
[
'Description' => '<string>',
'DisplayName' => '<string>',
'Locale' => '<string>',
'LogoUrl' => '<string>',
'WebsiteUrl' => '<string>',
],
// ...
],
'LogoUrl' => '<string>',
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES',
'ProfileId' => '<string>',
'TranslationSourceLocale' => '<string>',
'WebsiteUrl' => '<string>',
],
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- AwsTrainingCertificationEmailDomains
-
- Type: Array of PartnerDomain structures
The list of verified email domains associated with AWS training and certification credentials for the partner organization.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the partner account was created.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- LegalName
-
- Required: Yes
- Type: string
The legal name of the partner organization.
- Profile
-
- Required: Yes
- Type: PartnerProfile structure
The partner profile information including display name, description, and other public details.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetProfileUpdateTask
$result = $client->getProfileUpdateTask([/* ... */]); $promise = $client->getProfileUpdateTaskAsync([/* ... */]);
Retrieves information about a specific profile update task.
Parameter Syntax
$result = $client->getProfileUpdateTask([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'EndedAt' => <DateTime>,
'ErrorDetailList' => [
[
'Locale' => '<string>',
'Message' => '<string>',
'Reason' => 'INVALID_CONTENT|DUPLICATE_PROFILE|INVALID_LOGO|INVALID_LOGO_URL|INVALID_LOGO_FILE|INVALID_LOGO_SIZE|INVALID_WEBSITE_URL',
],
// ...
],
'Id' => '<string>',
'StartedAt' => <DateTime>,
'Status' => 'IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
'TaskDetails' => [
'Description' => '<string>',
'DisplayName' => '<string>',
'IndustrySegments' => ['<string>', ...],
'LocalizedContents' => [
[
'Description' => '<string>',
'DisplayName' => '<string>',
'Locale' => '<string>',
'LogoUrl' => '<string>',
'WebsiteUrl' => '<string>',
],
// ...
],
'LogoUrl' => '<string>',
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES',
'TranslationSourceLocale' => '<string>',
'WebsiteUrl' => '<string>',
],
'TaskId' => '<string>',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the profile update task.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task was completed or failed.
- ErrorDetailList
-
- Type: Array of ErrorDetail structures
A list of error details if any errors occurred during the profile update task.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task was started.
- Status
-
- Required: Yes
- Type: string
The current status of the profile update task (in progress, completed, failed, etc.).
- TaskDetails
-
- Required: Yes
- Type: TaskDetails structure
The details of the profile update task including what changes are being made.
- TaskId
-
- Required: Yes
- Type: string
The unique identifier of the profile update task.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
GetProfileVisibility
$result = $client->getProfileVisibility([/* ... */]); $promise = $client->getProfileVisibilityAsync([/* ... */]);
Retrieves the visibility settings for a partner profile, determining who can see the profile information.
Parameter Syntax
$result = $client->getProfileVisibility([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'Id' => '<string>',
'ProfileId' => '<string>',
'Visibility' => 'PRIVATE|PUBLIC',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- ProfileId
-
- Required: Yes
- Type: string
The unique identifier of the partner profile.
- Visibility
-
- Required: Yes
- Type: string
The visibility setting for the partner profile (public, private, restricted, etc.).
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
ListConnectionInvitations
$result = $client->listConnectionInvitations([/* ... */]); $promise = $client->listConnectionInvitationsAsync([/* ... */]);
Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
Parameter Syntax
$result = $client->listConnectionInvitations([
'Catalog' => '<string>', // REQUIRED
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'OtherParticipantIdentifiers' => ['<string>', ...],
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ConnectionType
-
- Type: string
Filter results by connection type (e.g., reseller, distributor, technology partner).
- MaxResults
-
- Type: int
The maximum number of connection invitations to return in a single response.
- NextToken
-
- Type: string
The token for retrieving the next page of results in paginated responses.
- OtherParticipantIdentifiers
-
- Type: Array of strings
Filter results by specific participant identifiers.
- ParticipantType
-
- Type: string
Filter results by participant type (inviter or invitee).
- Status
-
- Type: string
Filter results by invitation status (pending, accepted, rejected, canceled, expired).
Result Syntax
[
'ConnectionInvitationSummaries' => [
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionId' => '<string>',
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'CreatedAt' => <DateTime>,
'ExpiresAt' => <DateTime>,
'Id' => '<string>',
'OtherParticipantIdentifier' => '<string>',
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConnectionInvitationSummaries
-
- Required: Yes
- Type: Array of ConnectionInvitationSummary structures
A list of connection invitation summaries matching the specified criteria.
- NextToken
-
- Type: string
The token for retrieving the next page of results if more results are available.
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
ListConnections
$result = $client->listConnections([/* ... */]); $promise = $client->listConnectionsAsync([/* ... */]);
Lists active connections for the partner account, with optional filtering by connection type and participant.
Parameter Syntax
$result = $client->listConnections([
'Catalog' => '<string>', // REQUIRED
'ConnectionType' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'OtherParticipantIdentifiers' => ['<string>', ...],
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ConnectionType
-
- Type: string
Filter results by connection type (e.g., reseller, distributor, technology partner).
- MaxResults
-
- Type: int
The maximum number of connections to return in a single response.
- NextToken
-
- Type: string
The token for retrieving the next page of results in paginated responses.
- OtherParticipantIdentifiers
-
- Type: Array of strings
Filter results by specific participant identifiers.
Result Syntax
[
'ConnectionSummaries' => [
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionTypes' => [
'<ConnectionType>' => [
'OtherParticipant' => [
'Account' => [
'Name' => '<string>',
],
'PartnerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
'SellerProfile' => [
'Id' => '<string>',
'Name' => '<string>',
],
],
'Status' => 'ACTIVE|CANCELED',
],
// ...
],
'Id' => '<string>',
'OtherParticipantAccountId' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConnectionSummaries
-
- Required: Yes
- Type: Array of ConnectionSummary structures
A list of connection summaries matching the specified criteria.
- NextToken
-
- Type: string
The token for retrieving the next page of results if more results are available.
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
ListPartners
$result = $client->listPartners([/* ... */]); $promise = $client->listPartnersAsync([/* ... */]);
Lists partner accounts in the catalog, providing a summary view of all partners.
Parameter Syntax
$result = $client->listPartners([
'Catalog' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier to list partners from.
- NextToken
-
- Type: string
The token for retrieving the next page of results in paginated responses.
Result Syntax
[
'NextToken' => '<string>',
'PartnerSummaryList' => [
[
'Arn' => '<string>',
'Catalog' => '<string>',
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'LegalName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for retrieving the next page of results if more results are available.
- PartnerSummaryList
-
- Required: Yes
- Type: Array of PartnerSummary structures
A list of partner summaries including basic information about each partner account.
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists all tags associated with a specific AWS Partner Central Account resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to list tags for.
Result Syntax
[
'ResourceArn' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that the tags are associated with.
- Tags
-
- Type: Array of Tag structures
A list of tags associated with the specified resource.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
PutAllianceLeadContact
$result = $client->putAllianceLeadContact([/* ... */]); $promise = $client->putAllianceLeadContactAsync([/* ... */]);
Creates or updates the alliance lead contact information for a partner account.
Parameter Syntax
$result = $client->putAllianceLeadContact([
'AllianceLeadContact' => [ // REQUIRED
'BusinessTitle' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'FirstName' => '<string>', // REQUIRED
'LastName' => '<string>', // REQUIRED
],
'Catalog' => '<string>', // REQUIRED
'EmailVerificationCode' => '<string>',
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AllianceLeadContact
-
- Required: Yes
- Type: AllianceLeadContact structure
The alliance lead contact information to set for the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- EmailVerificationCode
-
- Type: string
The verification code sent to the alliance lead contact's email to confirm the update.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Result Syntax
[
'AllianceLeadContact' => [
'BusinessTitle' => '<string>',
'Email' => '<string>',
'FirstName' => '<string>',
'LastName' => '<string>',
],
'Arn' => '<string>',
'Catalog' => '<string>',
'Id' => '<string>',
]
Result Details
Members
- AllianceLeadContact
-
- Required: Yes
- Type: AllianceLeadContact structure
The updated alliance lead contact information.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
PutProfileVisibility
$result = $client->putProfileVisibility([/* ... */]); $promise = $client->putProfileVisibilityAsync([/* ... */]);
Sets the visibility level for a partner profile, controlling who can view the profile information.
Parameter Syntax
$result = $client->putProfileVisibility([
'Catalog' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
'Visibility' => 'PRIVATE|PUBLIC', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- Visibility
-
- Required: Yes
- Type: string
The visibility setting to apply to the partner profile.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'Id' => '<string>',
'ProfileId' => '<string>',
'Visibility' => 'PRIVATE|PUBLIC',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- ProfileId
-
- Required: Yes
- Type: string
The unique identifier of the partner profile.
- Visibility
-
- Required: Yes
- Type: string
The updated visibility setting for the partner profile.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
RejectConnectionInvitation
$result = $client->rejectConnectionInvitation([/* ... */]); $promise = $client->rejectConnectionInvitationAsync([/* ... */]);
Rejects a connection invitation from another partner, declining the partnership request.
Parameter Syntax
$result = $client->rejectConnectionInvitation([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'Identifier' => '<string>', // REQUIRED
'Reason' => '<string>',
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- ClientToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation to reject.
- Reason
-
- Type: string
The reason for rejecting the connection invitation.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'ConnectionId' => '<string>',
'ConnectionType' => 'OPPORTUNITY_COLLABORATION|SUBSIDIARY',
'CreatedAt' => <DateTime>,
'ExpiresAt' => <DateTime>,
'Id' => '<string>',
'InvitationMessage' => '<string>',
'InviterEmail' => '<string>',
'InviterName' => '<string>',
'OtherParticipantIdentifier' => '<string>',
'ParticipantType' => 'SENDER|RECEIVER',
'Status' => 'PENDING|ACCEPTED|REJECTED|CANCELED|EXPIRED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the rejected connection invitation.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation was rejected.
- ConnectionId
-
- Type: string
The identifier of the connection associated with the rejected invitation.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection that was being invited for.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was originally created.
- ExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation would have expired.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the rejected connection invitation.
- InvitationMessage
-
- Required: Yes
- Type: string
The message that was included with the original connection invitation.
- InviterEmail
-
- Required: Yes
- Type: string
The email address of the person who sent the connection invitation.
- InviterName
-
- Required: Yes
- Type: string
The name of the person who sent the connection invitation.
- OtherParticipantIdentifier
-
- Required: Yes
- Type: string
The identifier of the other participant who sent the invitation.
- ParticipantType
-
- Required: Yes
- Type: string
The type of participant (inviter or invitee) in the connection invitation.
- Status
-
- Required: Yes
- Type: string
The current status of the connection invitation (rejected).
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was last updated (rejected).
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
SendEmailVerificationCode
$result = $client->sendEmailVerificationCode([/* ... */]); $promise = $client->sendEmailVerificationCodeAsync([/* ... */]);
Sends an email verification code to the specified email address for account verification purposes.
Parameter Syntax
$result = $client->sendEmailVerificationCode([
'Catalog' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
-
- Required: Yes
- Type: string
The email address to send the verification code to.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
- 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.
StartProfileUpdateTask
$result = $client->startProfileUpdateTask([/* ... */]); $promise = $client->startProfileUpdateTaskAsync([/* ... */]);
Initiates a profile update task to modify partner profile information asynchronously.
Parameter Syntax
$result = $client->startProfileUpdateTask([
'Catalog' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'Identifier' => '<string>', // REQUIRED
'TaskDetails' => [ // REQUIRED
'Description' => '<string>', // REQUIRED
'DisplayName' => '<string>', // REQUIRED
'IndustrySegments' => ['<string>', ...], // REQUIRED
'LocalizedContents' => [
[
'Description' => '<string>', // REQUIRED
'DisplayName' => '<string>', // REQUIRED
'Locale' => '<string>', // REQUIRED
'LogoUrl' => '<string>', // REQUIRED
'WebsiteUrl' => '<string>', // REQUIRED
],
// ...
],
'LogoUrl' => '<string>', // REQUIRED
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES', // REQUIRED
'TranslationSourceLocale' => '<string>', // REQUIRED
'WebsiteUrl' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Identifier
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- TaskDetails
-
- Required: Yes
- Type: TaskDetails structure
The details of the profile updates to be performed.
Result Syntax
[
'Arn' => '<string>',
'Catalog' => '<string>',
'EndedAt' => <DateTime>,
'ErrorDetailList' => [
[
'Locale' => '<string>',
'Message' => '<string>',
'Reason' => 'INVALID_CONTENT|DUPLICATE_PROFILE|INVALID_LOGO|INVALID_LOGO_URL|INVALID_LOGO_FILE|INVALID_LOGO_SIZE|INVALID_WEBSITE_URL',
],
// ...
],
'Id' => '<string>',
'StartedAt' => <DateTime>,
'Status' => 'IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
'TaskDetails' => [
'Description' => '<string>',
'DisplayName' => '<string>',
'IndustrySegments' => ['<string>', ...],
'LocalizedContents' => [
[
'Description' => '<string>',
'DisplayName' => '<string>',
'Locale' => '<string>',
'LogoUrl' => '<string>',
'WebsiteUrl' => '<string>',
],
// ...
],
'LogoUrl' => '<string>',
'PrimarySolutionType' => 'SOFTWARE_PRODUCTS|CONSULTING_SERVICES|PROFESSIONAL_SERVICES|MANAGED_SERVICES|HARDWARE_PRODUCTS|COMMUNICATION_SERVICES|VALUE_ADDED_RESALE_AWS_SERVICES|TRAINING_SERVICES',
'TranslationSourceLocale' => '<string>',
'WebsiteUrl' => '<string>',
],
'TaskId' => '<string>',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the started profile update task.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task ended (null for in-progress tasks).
- ErrorDetailList
-
- Type: Array of ErrorDetail structures
A list of error details if any errors occurred during the profile update task.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the profile update task was started.
- Status
-
- Required: Yes
- Type: string
The current status of the profile update task (in progress).
- TaskDetails
-
- Required: Yes
- Type: TaskDetails structure
The details of the profile update task that was started.
- TaskId
-
- Required: Yes
- Type: string
The unique identifier of the started profile update task.
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- 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.
- 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.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or updates tags for a specified AWS Partner Central Account resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to tag.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
A list of tags to add or update for the specified resource.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes specified tags from an AWS Partner Central Account resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to remove tags from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
A list of tag keys to remove from the specified resource.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
UpdateConnectionPreferences
$result = $client->updateConnectionPreferences([/* ... */]); $promise = $client->updateConnectionPreferencesAsync([/* ... */]);
Updates the connection preferences for a partner account, modifying access settings and exclusions.
Parameter Syntax
$result = $client->updateConnectionPreferences([
'AccessType' => 'ALLOW_ALL|DENY_ALL|ALLOW_BY_DEFAULT_DENY_SOME', // REQUIRED
'Catalog' => '<string>', // REQUIRED
'ExcludedParticipantIdentifiers' => ['<string>', ...],
'Revision' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AccessType
-
- Required: Yes
- Type: string
The access type setting for connections (e.g., open, restricted, invitation-only).
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ExcludedParticipantIdentifiers
-
- Type: Array of strings
The updated list of participant identifiers to exclude from connections.
- Revision
-
- Required: Yes
- Type: long (int|float)
The revision number of the connection preferences for optimistic locking.
Result Syntax
[
'AccessType' => 'ALLOW_ALL|DENY_ALL|ALLOW_BY_DEFAULT_DENY_SOME',
'Arn' => '<string>',
'Catalog' => '<string>',
'ExcludedParticipantIds' => ['<string>', ...],
'Revision' => <integer>,
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- AccessType
-
- Required: Yes
- Type: string
The updated access type setting for connections.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the updated connection preferences.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- ExcludedParticipantIds
-
- Type: Array of strings
A list of participant IDs that are excluded from connection requests or interactions.
- Revision
-
- Required: Yes
- Type: long (int|float)
The updated revision number of the connection preferences.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection preferences were last updated.
Errors
- AccessDeniedException:
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- 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.
- 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.
- ValidationException:
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- InternalServerException:
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
Shapes
AccessDeniedException
Description
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
Members
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The specific reason for the access denial.
AccountSummary
Description
Summary information about an AWS account.
Members
- Name
-
- Required: Yes
- Type: string
The name associated with the AWS account.
AllianceLeadContact
Description
Contains contact information for the primary alliance lead responsible for partnership activities.
Members
- BusinessTitle
-
- Required: Yes
- Type: string
The business title or role of the alliance lead contact person.
-
- Required: Yes
- Type: string
The email address of the alliance lead contact person.
- FirstName
-
- Required: Yes
- Type: string
The first name of the alliance lead contact person.
- LastName
-
- Required: Yes
- Type: string
The last name of the alliance lead contact person.
BusinessValidationError
Description
Contains information about a business rule validation error that occurred during an operation.
Members
- Code
-
- Required: Yes
- Type: string
A code identifying the specific business validation error.
- Message
-
- Required: Yes
- Type: string
A description of the business validation error.
ConflictException
Description
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.
Members
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The specific reason for the conflict.
Connection
Description
Base structure containing common connection properties.
Members
- Arn
-
- Required: Yes
- Type: string
The AWS Resource Name (ARN) of the connection.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier that the connection belongs to.
- ConnectionTypes
-
- Required: Yes
- Type: Associative array of custom strings keys (ConnectionType) to ConnectionTypeDetail structures
The type of connection.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the connection.
- OtherParticipantAccountId
-
- Required: Yes
- Type: string
The AWS account ID of the other participant in the connection.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection was last updated.
ConnectionInvitationSummary
Description
A summary view of a connection invitation containing key information without full details.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection invitation.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection invitation exists.
- ConnectionId
-
- Type: string
The identifier of the connection associated with this invitation.
- ConnectionType
-
- Required: Yes
- Type: string
The type of connection being requested in the invitation.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was created.
- ExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation will expire.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the connection invitation.
- OtherParticipantIdentifier
-
- Required: Yes
- Type: string
The identifier of the other participant in the connection invitation.
- ParticipantType
-
- Required: Yes
- Type: string
The type of participant (inviter or invitee) in the connection invitation.
- Status
-
- Required: Yes
- Type: string
The current status of the connection invitation.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection invitation was last updated.
ConnectionSummary
Description
A summary view of an active connection between partners containing key information.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier where the connection exists.
- ConnectionTypes
-
- Required: Yes
- Type: Associative array of custom strings keys (ConnectionType) to ConnectionTypeSummary structures
A map of connection types and their summary information for this connection.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the connection.
- OtherParticipantAccountId
-
- Required: Yes
- Type: string
The AWS account ID of the other participant in the connection.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the connection was last updated.
ConnectionTypeDetail
Description
Detailed information about a specific connection type within a connection.
Members
- CanceledAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this connection type was cancelled, if applicable.
- CanceledBy
-
- Type: string
The AWS account ID of the participant who cancelled this connection type.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this connection type was created.
- InviterEmail
-
- Required: Yes
- Type: string
The email address of the person who initiated this connection type.
- InviterName
-
- Required: Yes
- Type: string
The name of the person who initiated this connection type.
- OtherParticipant
-
- Required: Yes
- Type: Participant structure
Information about the other participant in this connection type.
- Status
-
- Required: Yes
- Type: string
The current status of this connection type.
ConnectionTypeSummary
Description
Summary information about a specific connection type between partners.
Members
- OtherParticipant
-
- Required: Yes
- Type: Participant structure
Information about the other participant in this connection type.
- Status
-
- Required: Yes
- Type: string
The current status of this connection type (active, canceled, etc.).
ErrorDetail
Description
Contains detailed information about an error that occurred during an operation.
Members
- Locale
-
- Required: Yes
- Type: string
The locale or language code for the error message.
- Message
-
- Required: Yes
- Type: string
A human-readable description of the error.
- Reason
-
- Required: Yes
- Type: string
A machine-readable code or reason for the error.
FieldValidationError
Description
Contains information about a field-level validation error that occurred during an operation.
Members
- Code
-
- Required: Yes
- Type: string
A code identifying the specific field validation error.
- Message
-
- Required: Yes
- Type: string
A description of the field validation error.
- Name
-
- Required: Yes
- Type: string
The name of the field that failed validation.
InternalServerException
Description
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
Members
- Message
-
- Required: Yes
- Type: string
LocalizedContent
Description
Contains localized content for a partner profile in a specific language or locale.
Members
- Description
-
- Required: Yes
- Type: string
The localized description of the partner's business and services.
- DisplayName
-
- Required: Yes
- Type: string
The localized display name for the partner.
- Locale
-
- Required: Yes
- Type: string
The locale or language code for the localized content.
- LogoUrl
-
- Required: Yes
- Type: string
The URL to the partner's logo image for this locale.
- WebsiteUrl
-
- Required: Yes
- Type: string
The localized website URL for the partner.
Participant
Description
Represents a participant in a partner connection, containing their profile and account information.
Members
- Account
-
- Type: AccountSummary structure
The AWS account information for the participant.
- PartnerProfile
-
- Type: PartnerProfileSummary structure
The partner profile information for the participant.
- SellerProfile
-
- Type: SellerProfileSummary structure
The seller profile information for the participant.
PartnerDomain
Description
Represents a verified domain associated with a partner account.
Members
- DomainName
-
- Required: Yes
- Type: string
The domain name that has been verified for the partner account.
- RegisteredAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the domain was registered and verified for the partner account.
PartnerProfile
Description
Contains comprehensive profile information for a partner including public-facing details.
Members
- Description
-
- Required: Yes
- Type: string
A description of the partner's business, services, and capabilities.
- DisplayName
-
- Required: Yes
- Type: string
The public display name for the partner organization.
- IndustrySegments
-
- Required: Yes
- Type: Array of strings
The industry segments or verticals that the partner serves.
- LocalizedContents
-
- Type: Array of LocalizedContent structures
A list of localized content versions for different languages and regions.
- LogoUrl
-
- Required: Yes
- Type: string
The URL to the partner's logo image.
- PrimarySolutionType
-
- Required: Yes
- Type: string
The primary type of solution or service the partner provides.
- ProfileId
-
- Type: string
The unique identifier of the partner profile.
- TranslationSourceLocale
-
- Required: Yes
- Type: string
The source locale used for automatic translation of profile content.
- WebsiteUrl
-
- Required: Yes
- Type: string
The partner's primary website URL.
PartnerProfileSummary
Description
A summary view of a partner profile containing basic identifying information.
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner profile.
- Name
-
- Required: Yes
- Type: string
The display name of the partner.
PartnerSummary
Description
A summary view of a partner account containing basic information for listing purposes.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the partner account.
- Catalog
-
- Required: Yes
- Type: string
The catalog identifier for the partner account.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the partner account was created.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the partner account.
- LegalName
-
- Required: Yes
- Type: string
The legal name of the partner organization.
ResourceNotFoundException
Description
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
Members
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The specific reason why the resource was not found.
SellerProfileSummary
Description
A summary view of a seller profile containing basic identifying information.
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier of the seller profile.
- Name
-
- Required: Yes
- Type: string
The display name of the seller.
ServiceQuotaExceededException
Description
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.
Members
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The specific reason for the service quota being exceeded.
Tag
Description
A key-value pair used to associate metadata with AWS Partner Central Account resources.
Members
- Key
-
- Required: Yes
- Type: string
The key name of the tag. Tag keys are case-sensitive.
- Value
-
- Required: Yes
- Type: string
The value associated with the tag key. Tag values are case-sensitive.
TaskDetails
Description
Contains detailed information about a profile update task including the changes to be made.
Members
- Description
-
- Required: Yes
- Type: string
The updated description for the partner profile.
- DisplayName
-
- Required: Yes
- Type: string
The updated display name for the partner profile.
- IndustrySegments
-
- Required: Yes
- Type: Array of strings
The updated industry segments for the partner profile.
- LocalizedContents
-
- Type: Array of LocalizedContent structures
The updated localized content for the partner profile.
- LogoUrl
-
- Required: Yes
- Type: string
The updated logo URL for the partner profile.
- PrimarySolutionType
-
- Required: Yes
- Type: string
The updated primary solution type for the partner profile.
- TranslationSourceLocale
-
- Required: Yes
- Type: string
The updated translation source locale for the partner profile.
- WebsiteUrl
-
- Required: Yes
- Type: string
The updated website URL for the partner profile.
ThrottlingException
Description
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.
Members
- Message
-
- Required: Yes
- Type: string
- QuotaCode
-
- Type: string
The quota code associated with the throttling error.
- ServiceCode
-
- Type: string
The service code associated with the throttling error.
ValidationError
Description
Contains information about a validation error, which can be either a field-level or business rule validation error.
Members
- BusinessValidationError
-
- Type: BusinessValidationError structure
Details about a business rule validation error, if applicable.
- FieldValidationError
-
- Type: FieldValidationError structure
Details about a field-level validation error, if applicable.
ValidationException
Description
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
Members
- ErrorDetails
-
- Type: Array of ValidationError structures
A list of detailed validation errors that occurred during request processing.
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The reason for the validation failure.