Class: Aws::PartnerCentralAccount::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PartnerCentralAccount::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-partnercentralaccount/client.rb,
sig/client.rbs
Overview
An API client for PartnerCentralAccount. To construct a client, you need to configure a :region and :credentials.
client = Aws::PartnerCentralAccount::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Defined Under Namespace
Modules: _AcceptConnectionInvitationResponseSuccess, _AssociateAwsTrainingCertificationEmailDomainResponseSuccess, _CancelConnectionInvitationResponseSuccess, _CancelConnectionResponseSuccess, _CancelProfileUpdateTaskResponseSuccess, _CreateConnectionInvitationResponseSuccess, _CreatePartnerResponseSuccess, _DisassociateAwsTrainingCertificationEmailDomainResponseSuccess, _GetAllianceLeadContactResponseSuccess, _GetConnectionInvitationResponseSuccess, _GetConnectionPreferencesResponseSuccess, _GetConnectionResponseSuccess, _GetPartnerResponseSuccess, _GetProfileUpdateTaskResponseSuccess, _GetProfileVisibilityResponseSuccess, _GetVerificationResponseSuccess, _ListConnectionInvitationsResponseSuccess, _ListConnectionsResponseSuccess, _ListPartnersResponseSuccess, _ListTagsForResourceResponseSuccess, _PutAllianceLeadContactResponseSuccess, _PutProfileVisibilityResponseSuccess, _RejectConnectionInvitationResponseSuccess, _SendEmailVerificationCodeResponseSuccess, _StartProfileUpdateTaskResponseSuccess, _StartVerificationResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateConnectionPreferencesResponseSuccess
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#accept_connection_invitation(params = {}) ⇒ Types::AcceptConnectionInvitationResponse
Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.
-
#associate_aws_training_certification_email_domain(params = {}) ⇒ Struct
Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.
-
#cancel_connection(params = {}) ⇒ Types::CancelConnectionResponse
Cancels an existing connection between partners, terminating the partnership relationship.
-
#cancel_connection_invitation(params = {}) ⇒ Types::CancelConnectionInvitationResponse
Cancels a pending connection invitation before it has been accepted or rejected.
-
#cancel_profile_update_task(params = {}) ⇒ Types::CancelProfileUpdateTaskResponse
Cancels an in-progress profile update task, stopping any pending changes to the partner profile.
-
#create_connection_invitation(params = {}) ⇒ Types::CreateConnectionInvitationResponse
Creates a new connection invitation to establish a partnership with another organization.
-
#create_partner(params = {}) ⇒ Types::CreatePartnerResponse
Creates a new partner account in the AWS Partner Network with the specified details and configuration.
-
#disassociate_aws_training_certification_email_domain(params = {}) ⇒ Struct
Removes the association between an email domain and AWS training and certification for the partner account.
-
#get_alliance_lead_contact(params = {}) ⇒ Types::GetAllianceLeadContactResponse
Retrieves the alliance lead contact information for a partner account.
-
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves detailed information about a specific connection between partners.
-
#get_connection_invitation(params = {}) ⇒ Types::GetConnectionInvitationResponse
Retrieves detailed information about a specific connection invitation.
-
#get_connection_preferences(params = {}) ⇒ Types::GetConnectionPreferencesResponse
Retrieves the connection preferences for a partner account, including access settings and exclusions.
-
#get_partner(params = {}) ⇒ Types::GetPartnerResponse
Retrieves detailed information about a specific partner account.
-
#get_profile_update_task(params = {}) ⇒ Types::GetProfileUpdateTaskResponse
Retrieves information about a specific profile update task.
-
#get_profile_visibility(params = {}) ⇒ Types::GetProfileVisibilityResponse
Retrieves the visibility settings for a partner profile, determining who can see the profile information.
-
#get_verification(params = {}) ⇒ Types::GetVerificationResponse
Retrieves the current status and details of a verification process for a partner account.
-
#list_connection_invitations(params = {}) ⇒ Types::ListConnectionInvitationsResponse
Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
-
#list_connections(params = {}) ⇒ Types::ListConnectionsResponse
Lists active connections for the partner account, with optional filtering by connection type and participant.
-
#list_partners(params = {}) ⇒ Types::ListPartnersResponse
Lists partner accounts in the catalog, providing a summary view of all partners.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a specific AWS Partner Central Account resource.
-
#put_alliance_lead_contact(params = {}) ⇒ Types::PutAllianceLeadContactResponse
Creates or updates the alliance lead contact information for a partner account.
-
#put_profile_visibility(params = {}) ⇒ Types::PutProfileVisibilityResponse
Sets the visibility level for a partner profile, controlling who can view the profile information.
-
#reject_connection_invitation(params = {}) ⇒ Types::RejectConnectionInvitationResponse
Rejects a connection invitation from another partner, declining the partnership request.
-
#send_email_verification_code(params = {}) ⇒ Struct
Sends an email verification code to the specified email address for account verification purposes.
-
#start_profile_update_task(params = {}) ⇒ Types::StartProfileUpdateTaskResponse
Initiates a profile update task to modify partner profile information asynchronously.
-
#start_verification(params = {}) ⇒ Types::StartVerificationResponse
Initiates a new verification process for a partner account.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a specified AWS Partner Central Account resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes specified tags from an AWS Partner Central Account resource.
-
#update_connection_preferences(params = {}) ⇒ Types::UpdateConnectionPreferencesResponse
Updates the connection preferences for a partner account, modifying access settings and exclusions.
Class Method Summary collapse
- .errors_module ⇒ Object private
- .new ⇒ Object
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
478 479 480 |
# File 'lib/aws-sdk-partnercentralaccount/client.rb', line 478 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2154 2155 2156 |
# File 'lib/aws-sdk-partnercentralaccount/client.rb', line 2154 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2157 2158 2159 |
# File 'lib/aws-sdk-partnercentralaccount/client.rb', line 2157 def errors_module Errors end |
.new ⇒ Object
14 |
# File 'sig/client.rbs', line 14
def self.new: (
|
Instance Method Details
#accept_connection_invitation(params = {}) ⇒ Types::AcceptConnectionInvitationResponse
Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.
87 |
# File 'sig/client.rbs', line 87
def accept_connection_invitation: (
|
#associate_aws_training_certification_email_domain(params = {}) ⇒ Struct
Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.
98 |
# File 'sig/client.rbs', line 98
def associate_aws_training_certification_email_domain: (
|
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 |
# File 'lib/aws-sdk-partnercentralaccount/client.rb', line 2127 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::PartnerCentralAccount') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-partnercentralaccount' context[:gem_version] = '1.11.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_connection(params = {}) ⇒ Types::CancelConnectionResponse
Cancels an existing connection between partners, terminating the partnership relationship.
117 |
# File 'sig/client.rbs', line 117
def cancel_connection: (
|
#cancel_connection_invitation(params = {}) ⇒ Types::CancelConnectionInvitationResponse
Cancels a pending connection invitation before it has been accepted or rejected.
144 |
# File 'sig/client.rbs', line 144
def cancel_connection_invitation: (
|
#cancel_profile_update_task(params = {}) ⇒ Types::CancelProfileUpdateTaskResponse
Cancels an in-progress profile update task, stopping any pending changes to the partner profile.
164 |
# File 'sig/client.rbs', line 164
def cancel_profile_update_task: (
|
#create_connection_invitation(params = {}) ⇒ Types::CreateConnectionInvitationResponse
Creates a new connection invitation to establish a partnership with another organization.
190 |
# File 'sig/client.rbs', line 190
def create_connection_invitation: (
|
#create_partner(params = {}) ⇒ Types::CreatePartnerResponse
Creates a new partner account in the AWS Partner Network with the specified details and configuration.
213 |
# File 'sig/client.rbs', line 213
def create_partner: (
|
#disassociate_aws_training_certification_email_domain(params = {}) ⇒ Struct
Removes the association between an email domain and AWS training and certification for the partner account.
238 |
# File 'sig/client.rbs', line 238
def disassociate_aws_training_certification_email_domain: (
|
#get_alliance_lead_contact(params = {}) ⇒ Types::GetAllianceLeadContactResponse
Retrieves the alliance lead contact information for a partner account.
254 |
# File 'sig/client.rbs', line 254
def get_alliance_lead_contact: (
|
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves detailed information about a specific connection between partners.
270 |
# File 'sig/client.rbs', line 270
def get_connection: (
|
#get_connection_invitation(params = {}) ⇒ Types::GetConnectionInvitationResponse
Retrieves detailed information about a specific connection invitation.
294 |
# File 'sig/client.rbs', line 294
def get_connection_invitation: (
|
#get_connection_preferences(params = {}) ⇒ Types::GetConnectionPreferencesResponse
Retrieves the connection preferences for a partner account, including access settings and exclusions.
310 |
# File 'sig/client.rbs', line 310
def get_connection_preferences: (
|
#get_partner(params = {}) ⇒ Types::GetPartnerResponse
Retrieves detailed information about a specific partner account.
326 |
# File 'sig/client.rbs', line 326
def get_partner: (
|
#get_profile_update_task(params = {}) ⇒ Types::GetProfileUpdateTaskResponse
Retrieves information about a specific profile update task.
345 |
# File 'sig/client.rbs', line 345
def get_profile_update_task: (
|
#get_profile_visibility(params = {}) ⇒ Types::GetProfileVisibilityResponse
Retrieves the visibility settings for a partner profile, determining who can see the profile information.
360 |
# File 'sig/client.rbs', line 360
def get_profile_visibility: (
|
#get_verification(params = {}) ⇒ Types::GetVerificationResponse
Retrieves the current status and details of a verification process for a partner account. This operation allows partners to check the progress and results of business or registrant verification processes.
376 |
# File 'sig/client.rbs', line 376
def get_verification: (
|
#list_connection_invitations(params = {}) ⇒ Types::ListConnectionInvitationsResponse
Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
387 |
# File 'sig/client.rbs', line 387
def list_connection_invitations: (
|
#list_connections(params = {}) ⇒ Types::ListConnectionsResponse
Lists active connections for the partner account, with optional filtering by connection type and participant.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
404 |
# File 'sig/client.rbs', line 404
def list_connections: (
|
#list_partners(params = {}) ⇒ Types::ListPartnersResponse
Lists partner accounts in the catalog, providing a summary view of all partners.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
419 |
# File 'sig/client.rbs', line 419
def list_partners: (
|
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a specific AWS Partner Central Account resource.
431 |
# File 'sig/client.rbs', line 431
def list_tags_for_resource: (
|
#put_alliance_lead_contact(params = {}) ⇒ Types::PutAllianceLeadContactResponse
Creates or updates the alliance lead contact information for a partner account.
444 |
# File 'sig/client.rbs', line 444
def put_alliance_lead_contact: (
|
#put_profile_visibility(params = {}) ⇒ Types::PutProfileVisibilityResponse
Sets the visibility level for a partner profile, controlling who can view the profile information.
466 |
# File 'sig/client.rbs', line 466
def put_profile_visibility: (
|
#reject_connection_invitation(params = {}) ⇒ Types::RejectConnectionInvitationResponse
Rejects a connection invitation from another partner, declining the partnership request.
491 |
# File 'sig/client.rbs', line 491
def reject_connection_invitation: (
|
#send_email_verification_code(params = {}) ⇒ Struct
Sends an email verification code to the specified email address for account verification purposes.
503 |
# File 'sig/client.rbs', line 503
def send_email_verification_code: (
|
#start_profile_update_task(params = {}) ⇒ Types::StartProfileUpdateTaskResponse
Initiates a profile update task to modify partner profile information asynchronously.
522 |
# File 'sig/client.rbs', line 522
def start_profile_update_task: (
|
#start_verification(params = {}) ⇒ Types::StartVerificationResponse
Initiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.
557 |
# File 'sig/client.rbs', line 557
def start_verification: (
|
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a specified AWS Partner Central Account resource.
576 |
# File 'sig/client.rbs', line 576
def tag_resource: (
|
#untag_resource(params = {}) ⇒ Struct
Removes specified tags from an AWS Partner Central Account resource.
591 |
# File 'sig/client.rbs', line 591
def untag_resource: (
|
#update_connection_preferences(params = {}) ⇒ Types::UpdateConnectionPreferencesResponse
Updates the connection preferences for a partner account, modifying access settings and exclusions.
607 |
# File 'sig/client.rbs', line 607
def update_connection_preferences: (
|
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2147 2148 2149 |
# File 'lib/aws-sdk-partnercentralaccount/client.rb', line 2147 def waiter_names [] end |