Struct Client 

pub struct Client { /* private fields */ }

Client for Partner Central Channel API

Client for invoking operations on Partner Central Channel API. Each operation on Partner Central Channel API is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_partnercentralchannel::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_partnercentralchannel::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptChannelHandshake operation has a Client::accept_channel_handshake, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_channel_handshake()
    .catalog("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_channel_handshake(&self) -> AcceptChannelHandshakeFluentBuilder

Constructs a fluent builder for the AcceptChannelHandshake operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the handshake request.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the channel handshake to accept.

    
    
• On success, responds with AcceptChannelHandshakeOutput with field(s):
  • channel_handshake_detail(Option<AcceptChannelHandshakeDetail>):

    Details of the accepted channel handshake.

• On failure, responds with SdkError<AcceptChannelHandshakeError>

impl Client

pub fn cancel_channel_handshake(&self) -> CancelChannelHandshakeFluentBuilder

Constructs a fluent builder for the CancelChannelHandshake operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the handshake request.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the channel handshake to cancel.

    
    
• On success, responds with CancelChannelHandshakeOutput with field(s):
  • channel_handshake_detail(Option<CancelChannelHandshakeDetail>):

    Details of the canceled channel handshake.

• On failure, responds with SdkError<CancelChannelHandshakeError>

impl Client

pub fn create_channel_handshake(&self) -> CreateChannelHandshakeFluentBuilder

Constructs a fluent builder for the CreateChannelHandshake operation.

• The fluent builder is configurable:
  • handshake_type(HandshakeType) / set_handshake_type(Option<HandshakeType>):
    required: true
    

    The type of handshake to create (e.g., start service period, revoke service period).

    
    
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the handshake request.

    
    
  • associated_resource_identifier(impl Into<String>) / set_associated_resource_identifier(Option<String>):
    required: true
    

    The identifier of the resource associated with this handshake.

    
    
  • payload(ChannelHandshakePayload) / set_payload(Option<ChannelHandshakePayload>):
    required: false
    

    The payload containing specific details for the handshake type.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs to associate with the channel handshake.

    
    
• On success, responds with CreateChannelHandshakeOutput with field(s):
  • channel_handshake_detail(Option<CreateChannelHandshakeDetail>):

    Details of the created channel handshake.

• On failure, responds with SdkError<CreateChannelHandshakeError>

impl Client

pub fn create_program_management_account( &self, ) -> CreateProgramManagementAccountFluentBuilder

Constructs a fluent builder for the CreateProgramManagementAccount operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the program management account.

    
    
  • program(Program) / set_program(Option<Program>):
    required: true
    

    The program type for the management account.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A human-readable name for the program management account.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The AWS account ID to associate with the program management account.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs to associate with the program management account.

    
    
• On success, responds with CreateProgramManagementAccountOutput with field(s):
  • program_management_account_detail(Option<CreateProgramManagementAccountDetail>):

    Details of the created program management account.

• On failure, responds with SdkError<CreateProgramManagementAccountError>

impl Client

pub fn create_relationship(&self) -> CreateRelationshipFluentBuilder

Constructs a fluent builder for the CreateRelationship operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the relationship.

    
    
  • association_type(AssociationType) / set_association_type(Option<AssociationType>):
    required: true
    

    The type of association for the relationship (e.g., reseller, distributor).

    
    
  • program_management_account_identifier(impl Into<String>) / set_program_management_account_identifier(Option<String>):
    required: true
    

    The identifier of the program management account for this relationship.

    
    
  • associated_account_id(impl Into<String>) / set_associated_account_id(Option<String>):
    required: true
    

    The AWS account ID to associate in this relationship.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A human-readable name for the relationship.

    
    
  • resale_account_model(ResaleAccountModel) / set_resale_account_model(Option<ResaleAccountModel>):
    required: false
    

    The resale account model for the relationship.

    
    
  • sector(Sector) / set_sector(Option<Sector>):
    required: true
    

    The business sector for the relationship.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs to associate with the relationship.

    
    
  • requested_support_plan(SupportPlan) / set_requested_support_plan(Option<SupportPlan>):
    required: false
    

    The support plan requested for this relationship.

    
    
• On success, responds with CreateRelationshipOutput with field(s):
  • relationship_detail(Option<CreateRelationshipDetail>):

    Details of the created relationship.

• On failure, responds with SdkError<CreateRelationshipError>

impl Client

pub fn delete_program_management_account( &self, ) -> DeleteProgramManagementAccountFluentBuilder

Constructs a fluent builder for the DeleteProgramManagementAccount operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the program management account.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the program management account to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteProgramManagementAccountOutput
• On failure, responds with SdkError<DeleteProgramManagementAccountError>

impl Client

pub fn delete_relationship(&self) -> DeleteRelationshipFluentBuilder

Constructs a fluent builder for the DeleteRelationship operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the relationship.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the relationship to delete.

    
    
  • program_management_account_identifier(impl Into<String>) / set_program_management_account_identifier(Option<String>):
    required: true
    

    The identifier of the program management account associated with the relationship.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteRelationshipOutput
• On failure, responds with SdkError<DeleteRelationshipError>

impl Client

pub fn get_relationship(&self) -> GetRelationshipFluentBuilder

Constructs a fluent builder for the GetRelationship operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the relationship.

    
    
  • program_management_account_identifier(impl Into<String>) / set_program_management_account_identifier(Option<String>):
    required: true
    

    The identifier of the program management account associated with the relationship.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the relationship to retrieve.

    
    
• On success, responds with GetRelationshipOutput with field(s):
  • relationship_detail(Option<RelationshipDetail>):

    Details of the requested relationship.

• On failure, responds with SdkError<GetRelationshipError>

impl Client

pub fn list_channel_handshakes(&self) -> ListChannelHandshakesFluentBuilder

Constructs a fluent builder for the ListChannelHandshakes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • handshake_type(HandshakeType) / set_handshake_type(Option<HandshakeType>):
    required: true
    

    Filter results by handshake type.

    
    
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier to filter handshakes.

    
    
  • participant_type(ParticipantType) / set_participant_type(Option<ParticipantType>):
    required: true
    

    Filter by participant type (sender or receiver).

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • statuses(HandshakeStatus) / set_statuses(Option<Vec::<HandshakeStatus>>):
    required: false
    

    Filter results by handshake status.

    
    
  • associated_resource_identifiers(impl Into<String>) / set_associated_resource_identifiers(Option<Vec::<String>>):
    required: false
    

    Filter by associated resource identifiers.

    
    
  • handshake_type_filters(ListChannelHandshakesTypeFilters) / set_handshake_type_filters(Option<ListChannelHandshakesTypeFilters>):
    required: false
    

    Type-specific filters for handshakes.

    
    
  • handshake_type_sort(ListChannelHandshakesTypeSort) / set_handshake_type_sort(Option<ListChannelHandshakesTypeSort>):
    required: false
    

    Type-specific sorting options for handshakes.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Token for retrieving the next page of results.

    
    
• On success, responds with ListChannelHandshakesOutput with field(s):
  • items(Option<Vec::<ChannelHandshakeSummary>>):

    List of channel handshakes matching the criteria.

  • next_token(Option<String>):

    Token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListChannelHandshakesError>

impl Client

pub fn list_program_management_accounts( &self, ) -> ListProgramManagementAccountsFluentBuilder

Constructs a fluent builder for the ListProgramManagementAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier to filter accounts.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • display_names(impl Into<String>) / set_display_names(Option<Vec::<String>>):
    required: false
    

    Filter by display names.

    
    
  • programs(Program) / set_programs(Option<Vec::<Program>>):
    required: false
    

    Filter by program types.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    Filter by AWS account IDs.

    
    
  • statuses(ProgramManagementAccountStatus) / set_statuses(Option<Vec::<ProgramManagementAccountStatus>>):
    required: false
    

    Filter by program management account statuses.

    
    
  • sort(ListProgramManagementAccountsSortBase) / set_sort(Option<ListProgramManagementAccountsSortBase>):
    required: false
    

    Sorting options for the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Token for retrieving the next page of results.

    
    
• On success, responds with ListProgramManagementAccountsOutput with field(s):
  • items(Option<Vec::<ProgramManagementAccountSummary>>):

    List of program management accounts matching the criteria.

  • next_token(Option<String>):

    Token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListProgramManagementAccountsError>

impl Client

pub fn list_relationships(&self) -> ListRelationshipsFluentBuilder

Constructs a fluent builder for the ListRelationships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier to filter relationships.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • associated_account_ids(impl Into<String>) / set_associated_account_ids(Option<Vec::<String>>):
    required: false
    

    Filter by associated AWS account IDs.

    
    
  • association_types(AssociationType) / set_association_types(Option<Vec::<AssociationType>>):
    required: false
    

    Filter by association types.

    
    
  • display_names(impl Into<String>) / set_display_names(Option<Vec::<String>>):
    required: false
    

    Filter by display names.

    
    
  • program_management_account_identifiers(impl Into<String>) / set_program_management_account_identifiers(Option<Vec::<String>>):
    required: false
    

    Filter by program management account identifiers.

    
    
  • sort(ListRelationshipsSortBase) / set_sort(Option<ListRelationshipsSortBase>):
    required: false
    

    Sorting options for the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Token for retrieving the next page of results.

    
    
• On success, responds with ListRelationshipsOutput with field(s):
  • items(Option<Vec::<RelationshipSummary>>):

    List of relationships matching the criteria.

  • next_token(Option<String>):

    Token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListRelationshipsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to list tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    Key-value pairs associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn reject_channel_handshake(&self) -> RejectChannelHandshakeFluentBuilder

Constructs a fluent builder for the RejectChannelHandshake operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the handshake request.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the channel handshake to reject.

    
    
• On success, responds with RejectChannelHandshakeOutput with field(s):
  • channel_handshake_detail(Option<RejectChannelHandshakeDetail>):

    Details of the rejected channel handshake.

• On failure, responds with SdkError<RejectChannelHandshakeError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to tag.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Key-value pairs to associate with the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_program_management_account( &self, ) -> UpdateProgramManagementAccountFluentBuilder

Constructs a fluent builder for the UpdateProgramManagementAccount operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the program management account.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the program management account to update.

    
    
  • revision(impl Into<String>) / set_revision(Option<String>):
    required: false
    

    The current revision number of the program management account.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new display name for the program management account.

    
    
• On success, responds with UpdateProgramManagementAccountOutput with field(s):
  • program_management_account_detail(Option<UpdateProgramManagementAccountDetail>):

    Details of the updated program management account.

• On failure, responds with SdkError<UpdateProgramManagementAccountError>

impl Client

pub fn update_relationship(&self) -> UpdateRelationshipFluentBuilder

Constructs a fluent builder for the UpdateRelationship operation.

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: true
    

    The catalog identifier for the relationship.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the relationship to update.

    
    
  • program_management_account_identifier(impl Into<String>) / set_program_management_account_identifier(Option<String>):
    required: true
    

    The identifier of the program management account associated with the relationship.

    
    
  • revision(impl Into<String>) / set_revision(Option<String>):
    required: false
    

    The current revision number of the relationship.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new display name for the relationship.

    
    
  • requested_support_plan(SupportPlan) / set_requested_support_plan(Option<SupportPlan>):
    required: false
    

    The updated support plan for the relationship.

    
    
• On success, responds with UpdateRelationshipOutput with field(s):
  • relationship_detail(Option<UpdateRelationshipDetail>):

    Details of the updated relationship.

• On failure, responds with SdkError<UpdateRelationshipError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.