Class: Aws::PartnerCentralAccount::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb

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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PartnerCentralAccount::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::PartnerCentralAccount::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 478

def initialize(*args)
  super
end

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.

Examples:

Request syntax with placeholder values


resp = client.accept_connection_invitation({
  catalog: "Catalog", # required
  identifier: "ConnectionInvitationId", # required
  client_token: "ClientToken", # required
})

Response structure


resp.connection.catalog #=> String
resp.connection.id #=> String
resp.connection.arn #=> String
resp.connection. #=> String
resp.connection.updated_at #=> Time
resp.connection.connection_types #=> Hash
resp.connection.connection_types["ConnectionType"].created_at #=> Time
resp.connection.connection_types["ConnectionType"].inviter_email #=> String
resp.connection.connection_types["ConnectionType"].inviter_name #=> String
resp.connection.connection_types["ConnectionType"].status #=> String, one of "ACTIVE", "CANCELED"
resp.connection.connection_types["ConnectionType"].canceled_at #=> Time
resp.connection.connection_types["ConnectionType"].canceled_by #=> String
resp.connection.connection_types["ConnectionType"].other_participant.partner_profile.id #=> String
resp.connection.connection_types["ConnectionType"].other_participant.partner_profile.name #=> String
resp.connection.connection_types["ConnectionType"].other_participant.seller_profile.id #=> String
resp.connection.connection_types["ConnectionType"].other_participant.seller_profile.name #=> String
resp.connection.connection_types["ConnectionType"].other_participant..name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection invitation exists.

  • :identifier (required, String) —

    The unique identifier of the connection invitation to accept.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 536

def accept_connection_invitation(params = {}, options = {})
  req = build_request(:accept_connection_invitation, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.associate_aws_training_certification_email_domain({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  email: "Email", # required
  email_verification_code: "EmailVerificationCode", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :email (required, String) —

    The email address used to verify domain ownership for AWS training and certification association.

  • :email_verification_code (required, String) —

    The verification code sent to the email address to confirm domain ownership.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



582
583
584
585
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 582

def associate_aws_training_certification_email_domain(params = {}, options = {})
  req = build_request(:associate_aws_training_certification_email_domain, params)
  req.send_request(options)
end

#cancel_connection(params = {}) ⇒ Types::CancelConnectionResponse

Cancels an existing connection between partners, terminating the partnership relationship.

Examples:

Request syntax with placeholder values


resp = client.cancel_connection({
  catalog: "Catalog", # required
  identifier: "ConnectionId", # required
  connection_type: "OPPORTUNITY_COLLABORATION", # required, accepts OPPORTUNITY_COLLABORATION, SUBSIDIARY
  reason: "CancelConnectionRequestReasonString", # required
  client_token: "ClientToken", # required
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp. #=> String
resp.updated_at #=> Time
resp.connection_types #=> Hash
resp.connection_types["ConnectionType"].created_at #=> Time
resp.connection_types["ConnectionType"].inviter_email #=> String
resp.connection_types["ConnectionType"].inviter_name #=> String
resp.connection_types["ConnectionType"].status #=> String, one of "ACTIVE", "CANCELED"
resp.connection_types["ConnectionType"].canceled_at #=> Time
resp.connection_types["ConnectionType"].canceled_by #=> String
resp.connection_types["ConnectionType"].other_participant.partner_profile.id #=> String
resp.connection_types["ConnectionType"].other_participant.partner_profile.name #=> String
resp.connection_types["ConnectionType"].other_participant.seller_profile.id #=> String
resp.connection_types["ConnectionType"].other_participant.seller_profile.name #=> String
resp.connection_types["ConnectionType"].other_participant..name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection exists.

  • :identifier (required, String) —

    The unique identifier of the connection to cancel.

  • :connection_type (required, String) —

    The type of connection to cancel (e.g., reseller, distributor, technology partner).

  • :reason (required, String) —

    The reason for canceling the connection, providing context for the termination.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



654
655
656
657
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 654

def cancel_connection(params = {}, options = {})
  req = build_request(:cancel_connection, params)
  req.send_request(options)
end

#cancel_connection_invitation(params = {}) ⇒ Types::CancelConnectionInvitationResponse

Cancels a pending connection invitation before it has been accepted or rejected.

Examples:

Request syntax with placeholder values


resp = client.cancel_connection_invitation({
  catalog: "Catalog", # required
  identifier: "ConnectionInvitationId", # required
  client_token: "ClientToken", # required
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp.connection_id #=> String
resp.connection_type #=> String, one of "OPPORTUNITY_COLLABORATION", "SUBSIDIARY"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.expires_at #=> Time
resp.other_participant_identifier #=> String
resp.participant_type #=> String, one of "SENDER", "RECEIVER"
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.invitation_message #=> String
resp.inviter_email #=> String
resp.inviter_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection invitation exists.

  • :identifier (required, String) —

    The unique identifier of the connection invitation to cancel.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



721
722
723
724
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 721

def cancel_connection_invitation(params = {}, options = {})
  req = build_request(:cancel_connection_invitation, params)
  req.send_request(options)
end

#cancel_profile_update_task(params = {}) ⇒ Types::CancelProfileUpdateTaskResponse

Cancels an in-progress profile update task, stopping any pending changes to the partner profile.

Examples:

Request syntax with placeholder values


resp = client.cancel_profile_update_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  task_id: "ProfileTaskId", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.task_details.display_name #=> String
resp.task_details.description #=> String
resp.task_details.website_url #=> String
resp.task_details.logo_url #=> String
resp.task_details.primary_solution_type #=> String, one of "SOFTWARE_PRODUCTS", "CONSULTING_SERVICES", "PROFESSIONAL_SERVICES", "MANAGED_SERVICES", "HARDWARE_PRODUCTS", "COMMUNICATION_SERVICES", "VALUE_ADDED_RESALE_AWS_SERVICES", "TRAINING_SERVICES"
resp.task_details.industry_segments #=> Array
resp.task_details.industry_segments[0] #=> String, one of "AGRICULTURE_MINING", "BIOTECHNOLOGY", "BUSINESS_CONSUMER_SERVICES", "BUSINESS_SERV", "COMMUNICATIONS", "COMPUTER_HARDWARE", "COMPUTERS_ELECTRONICS", "COMPUTER_SOFTWARE", "CONSUMER_GOODS", "CONSUMER_RELATED", "EDUCATION", "ENERGY_UTILITIES", "FINANCIAL_SERVICES", "GAMING", "GOVERNMENT", "GOVERNMENT_EDUCATION_PUBLIC_SERVICES", "HEALTHCARE", "HEALTHCARE_PHARMACEUTICALS_BIOTECH", "INDUSTRIAL_ENERGY", "INTERNET_SPECIFIC", "LIFE_SCIENCES", "MANUFACTURING", "MEDIA_ENTERTAINMENT_LEISURE", "MEDIA_ENTERTAINMENT", "MEDICAL_HEALTH", "NON_PROFIT_ORGANIZATION", "OTHER", "PROFESSIONAL_SERVICES", "REAL_ESTATE_CONSTRUCTION", "RETAIL", "RETAIL_WHOLESALE_DISTRIBUTION", "SEMICONDUCTOR_ELECTR", "SOFTWARE_INTERNET", "TELECOMMUNICATIONS", "TRANSPORTATION_LOGISTICS", "TRAVEL_HOSPITALITY", "WHOLESALE_DISTRIBUTION"
resp.task_details.translation_source_locale #=> String
resp.task_details.localized_contents #=> Array
resp.task_details.localized_contents[0].display_name #=> String
resp.task_details.localized_contents[0].description #=> String
resp.task_details.localized_contents[0].website_url #=> String
resp.task_details.localized_contents[0].logo_url #=> String
resp.task_details.localized_contents[0].locale #=> String
resp.task_details.headquarters.country_code #=> String
resp.task_details.headquarters.subdivision_code #=> String
resp.started_at #=> Time
resp.status #=> String, one of "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.ended_at #=> Time
resp.error_detail_list #=> Array
resp.error_detail_list[0].locale #=> String
resp.error_detail_list[0].message #=> String
resp.error_detail_list[0].reason #=> String, one of "INVALID_CONTENT", "DUPLICATE_PROFILE", "INVALID_LOGO", "INVALID_LOGO_URL", "INVALID_LOGO_FILE", "INVALID_LOGO_SIZE", "INVALID_WEBSITE_URL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :task_id (required, String) —

    The unique identifier of the profile update task to cancel.

Returns:

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 800

def cancel_profile_update_task(params = {}, options = {})
  req = build_request(:cancel_profile_update_task, params)
  req.send_request(options)
end

#create_connection_invitation(params = {}) ⇒ Types::CreateConnectionInvitationResponse

Creates a new connection invitation to establish a partnership with another organization.

Examples:

Request syntax with placeholder values


resp = client.create_connection_invitation({
  catalog: "Catalog", # required
  client_token: "ClientToken", # required
  connection_type: "OPPORTUNITY_COLLABORATION", # required, accepts OPPORTUNITY_COLLABORATION, SUBSIDIARY
  email: "Email", # required
  message: "CreateConnectionInvitationRequestMessageString", # required
  name: "SensitiveUnicodeString", # required
  receiver_identifier: "ParticipantIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp.connection_id #=> String
resp.connection_type #=> String, one of "OPPORTUNITY_COLLABORATION", "SUBSIDIARY"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.expires_at #=> Time
resp.other_participant_identifier #=> String
resp.participant_type #=> String, one of "SENDER", "RECEIVER"
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.invitation_message #=> String
resp.inviter_email #=> String
resp.inviter_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection invitation will be created.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_type (required, String) —

    The type of connection being requested (e.g., reseller, distributor, technology partner).

  • :email (required, String) —

    The email address of the person to send the connection invitation to.

  • :message (required, String) —

    A custom message to include with the connection invitation.

  • :name (required, String) —

    The name of the person sending the connection invitation.

  • :receiver_identifier (required, String) —

    The identifier of the organization or partner to invite for connection.

Returns:

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 886

def create_connection_invitation(params = {}, options = {})
  req = build_request(:create_connection_invitation, params)
  req.send_request(options)
end

#create_partner(params = {}) ⇒ Types::CreatePartnerResponse

Creates a new partner account in the AWS Partner Network with the specified details and configuration.

Examples:

Request syntax with placeholder values


resp = client.create_partner({
  catalog: "Catalog", # required
  client_token: "ClientToken",
  legal_name: "SensitiveUnicodeString", # required
  primary_solution_type: "SOFTWARE_PRODUCTS", # required, accepts SOFTWARE_PRODUCTS, CONSULTING_SERVICES, PROFESSIONAL_SERVICES, MANAGED_SERVICES, HARDWARE_PRODUCTS, COMMUNICATION_SERVICES, VALUE_ADDED_RESALE_AWS_SERVICES, TRAINING_SERVICES
  alliance_lead_contact: { # required
    first_name: "SensitiveUnicodeString", # required
    last_name: "SensitiveUnicodeString", # required
    email: "Email", # required
    business_title: "SensitiveUnicodeString", # required
  },
  email_verification_code: "EmailVerificationCode", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.legal_name #=> String
resp.created_at #=> Time
resp.profile.display_name #=> String
resp.profile.description #=> String
resp.profile.website_url #=> String
resp.profile.logo_url #=> String
resp.profile.primary_solution_type #=> String, one of "SOFTWARE_PRODUCTS", "CONSULTING_SERVICES", "PROFESSIONAL_SERVICES", "MANAGED_SERVICES", "HARDWARE_PRODUCTS", "COMMUNICATION_SERVICES", "VALUE_ADDED_RESALE_AWS_SERVICES", "TRAINING_SERVICES"
resp.profile.industry_segments #=> Array
resp.profile.industry_segments[0] #=> String, one of "AGRICULTURE_MINING", "BIOTECHNOLOGY", "BUSINESS_CONSUMER_SERVICES", "BUSINESS_SERV", "COMMUNICATIONS", "COMPUTER_HARDWARE", "COMPUTERS_ELECTRONICS", "COMPUTER_SOFTWARE", "CONSUMER_GOODS", "CONSUMER_RELATED", "EDUCATION", "ENERGY_UTILITIES", "FINANCIAL_SERVICES", "GAMING", "GOVERNMENT", "GOVERNMENT_EDUCATION_PUBLIC_SERVICES", "HEALTHCARE", "HEALTHCARE_PHARMACEUTICALS_BIOTECH", "INDUSTRIAL_ENERGY", "INTERNET_SPECIFIC", "LIFE_SCIENCES", "MANUFACTURING", "MEDIA_ENTERTAINMENT_LEISURE", "MEDIA_ENTERTAINMENT", "MEDICAL_HEALTH", "NON_PROFIT_ORGANIZATION", "OTHER", "PROFESSIONAL_SERVICES", "REAL_ESTATE_CONSTRUCTION", "RETAIL", "RETAIL_WHOLESALE_DISTRIBUTION", "SEMICONDUCTOR_ELECTR", "SOFTWARE_INTERNET", "TELECOMMUNICATIONS", "TRANSPORTATION_LOGISTICS", "TRAVEL_HOSPITALITY", "WHOLESALE_DISTRIBUTION"
resp.profile.translation_source_locale #=> String
resp.profile.localized_contents #=> Array
resp.profile.localized_contents[0].display_name #=> String
resp.profile.localized_contents[0].description #=> String
resp.profile.localized_contents[0].website_url #=> String
resp.profile.localized_contents[0].logo_url #=> String
resp.profile.localized_contents[0].locale #=> String
resp.profile.headquarters.country_code #=> String
resp.profile.headquarters.subdivision_code #=> String
resp.profile.profile_id #=> String
resp.aws_training_certification_email_domains #=> Array
resp.aws_training_certification_email_domains[0].domain_name #=> String
resp.aws_training_certification_email_domains[0].registered_at #=> Time
resp.alliance_lead_contact.first_name #=> String
resp.alliance_lead_contact.last_name #=> String
resp.alliance_lead_contact.email #=> String
resp.alliance_lead_contact.business_title #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the partner account will be created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :legal_name (required, String) —

    The legal name of the organization becoming a partner.

  • :primary_solution_type (required, String) —

    The primary type of solution or service the partner provides (e.g., consulting, software, managed services).

  • :alliance_lead_contact (required, Types::AllianceLeadContact) —

    The primary contact person for alliance and partnership matters.

  • :email_verification_code (required, String) —

    The verification code sent to the alliance lead contact's email to confirm account creation.

  • :tags (Array<Types::Tag>) —

    A list of tags to associate with the partner account for organization and billing purposes.

Returns:

See Also:



991
992
993
994
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 991

def create_partner(params = {}, options = {})
  req = build_request(:create_partner, params)
  req.send_request(options)
end

#disassociate_aws_training_certification_email_domain(params = {}) ⇒ Struct

Removes the association between an email domain and AWS training and certification for the partner account.

Examples:

Request syntax with placeholder values


resp = client.disassociate_aws_training_certification_email_domain({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  domain_name: "DomainName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :domain_name (required, String) —

    The domain name to disassociate from AWS training and certification.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1030
1031
1032
1033
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1030

def disassociate_aws_training_certification_email_domain(params = {}, options = {})
  req = build_request(:disassociate_aws_training_certification_email_domain, params)
  req.send_request(options)
end

#get_alliance_lead_contact(params = {}) ⇒ Types::GetAllianceLeadContactResponse

Retrieves the alliance lead contact information for a partner account.

Examples:

Request syntax with placeholder values


resp = client.get_alliance_lead_contact({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.alliance_lead_contact.first_name #=> String
resp.alliance_lead_contact.last_name #=> String
resp.alliance_lead_contact.email #=> String
resp.alliance_lead_contact.business_title #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

Returns:

See Also:



1071
1072
1073
1074
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1071

def get_alliance_lead_contact(params = {}, options = {})
  req = build_request(:get_alliance_lead_contact, params)
  req.send_request(options)
end

#get_connection(params = {}) ⇒ Types::GetConnectionResponse

Retrieves detailed information about a specific connection between partners.

Examples:

Request syntax with placeholder values


resp = client.get_connection({
  catalog: "Catalog", # required
  identifier: "ConnectionId", # required
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp. #=> String
resp.updated_at #=> Time
resp.connection_types #=> Hash
resp.connection_types["ConnectionType"].created_at #=> Time
resp.connection_types["ConnectionType"].inviter_email #=> String
resp.connection_types["ConnectionType"].inviter_name #=> String
resp.connection_types["ConnectionType"].status #=> String, one of "ACTIVE", "CANCELED"
resp.connection_types["ConnectionType"].canceled_at #=> Time
resp.connection_types["ConnectionType"].canceled_by #=> String
resp.connection_types["ConnectionType"].other_participant.partner_profile.id #=> String
resp.connection_types["ConnectionType"].other_participant.partner_profile.name #=> String
resp.connection_types["ConnectionType"].other_participant.seller_profile.id #=> String
resp.connection_types["ConnectionType"].other_participant.seller_profile.name #=> String
resp.connection_types["ConnectionType"].other_participant..name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection exists.

  • :identifier (required, String) —

    The unique identifier of the connection to retrieve.

Returns:

See Also:



1125
1126
1127
1128
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1125

def get_connection(params = {}, options = {})
  req = build_request(:get_connection, params)
  req.send_request(options)
end

#get_connection_invitation(params = {}) ⇒ Types::GetConnectionInvitationResponse

Retrieves detailed information about a specific connection invitation.

Examples:

Request syntax with placeholder values


resp = client.get_connection_invitation({
  catalog: "Catalog", # required
  identifier: "ConnectionInvitationId", # required
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp.connection_id #=> String
resp.connection_type #=> String, one of "OPPORTUNITY_COLLABORATION", "SUBSIDIARY"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.expires_at #=> Time
resp.other_participant_identifier #=> String
resp.participant_type #=> String, one of "SENDER", "RECEIVER"
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.invitation_message #=> String
resp.inviter_email #=> String
resp.inviter_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection invitation exists.

  • :identifier (required, String) —

    The unique identifier of the connection invitation to retrieve.

Returns:

See Also:



1183
1184
1185
1186
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1183

def get_connection_invitation(params = {}, options = {})
  req = build_request(:get_connection_invitation, params)
  req.send_request(options)
end

#get_connection_preferences(params = {}) ⇒ Types::GetConnectionPreferencesResponse

Retrieves the connection preferences for a partner account, including access settings and exclusions.

Examples:

Request syntax with placeholder values


resp = client.get_connection_preferences({
  catalog: "Catalog", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.access_type #=> String, one of "ALLOW_ALL", "DENY_ALL", "ALLOW_BY_DEFAULT_DENY_SOME"
resp.excluded_participant_ids #=> Array
resp.excluded_participant_ids[0] #=> String
resp.updated_at #=> Time
resp.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

Returns:

See Also:



1223
1224
1225
1226
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1223

def get_connection_preferences(params = {}, options = {})
  req = build_request(:get_connection_preferences, params)
  req.send_request(options)
end

#get_partner(params = {}) ⇒ Types::GetPartnerResponse

Retrieves detailed information about a specific partner account.

Examples:

Request syntax with placeholder values


resp = client.get_partner({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.legal_name #=> String
resp.created_at #=> Time
resp.profile.display_name #=> String
resp.profile.description #=> String
resp.profile.website_url #=> String
resp.profile.logo_url #=> String
resp.profile.primary_solution_type #=> String, one of "SOFTWARE_PRODUCTS", "CONSULTING_SERVICES", "PROFESSIONAL_SERVICES", "MANAGED_SERVICES", "HARDWARE_PRODUCTS", "COMMUNICATION_SERVICES", "VALUE_ADDED_RESALE_AWS_SERVICES", "TRAINING_SERVICES"
resp.profile.industry_segments #=> Array
resp.profile.industry_segments[0] #=> String, one of "AGRICULTURE_MINING", "BIOTECHNOLOGY", "BUSINESS_CONSUMER_SERVICES", "BUSINESS_SERV", "COMMUNICATIONS", "COMPUTER_HARDWARE", "COMPUTERS_ELECTRONICS", "COMPUTER_SOFTWARE", "CONSUMER_GOODS", "CONSUMER_RELATED", "EDUCATION", "ENERGY_UTILITIES", "FINANCIAL_SERVICES", "GAMING", "GOVERNMENT", "GOVERNMENT_EDUCATION_PUBLIC_SERVICES", "HEALTHCARE", "HEALTHCARE_PHARMACEUTICALS_BIOTECH", "INDUSTRIAL_ENERGY", "INTERNET_SPECIFIC", "LIFE_SCIENCES", "MANUFACTURING", "MEDIA_ENTERTAINMENT_LEISURE", "MEDIA_ENTERTAINMENT", "MEDICAL_HEALTH", "NON_PROFIT_ORGANIZATION", "OTHER", "PROFESSIONAL_SERVICES", "REAL_ESTATE_CONSTRUCTION", "RETAIL", "RETAIL_WHOLESALE_DISTRIBUTION", "SEMICONDUCTOR_ELECTR", "SOFTWARE_INTERNET", "TELECOMMUNICATIONS", "TRANSPORTATION_LOGISTICS", "TRAVEL_HOSPITALITY", "WHOLESALE_DISTRIBUTION"
resp.profile.translation_source_locale #=> String
resp.profile.localized_contents #=> Array
resp.profile.localized_contents[0].display_name #=> String
resp.profile.localized_contents[0].description #=> String
resp.profile.localized_contents[0].website_url #=> String
resp.profile.localized_contents[0].logo_url #=> String
resp.profile.localized_contents[0].locale #=> String
resp.profile.headquarters.country_code #=> String
resp.profile.headquarters.subdivision_code #=> String
resp.profile.profile_id #=> String
resp.aws_training_certification_email_domains #=> Array
resp.aws_training_certification_email_domains[0].domain_name #=> String
resp.aws_training_certification_email_domains[0].registered_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account to retrieve.

Returns:

See Also:



1285
1286
1287
1288
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1285

def get_partner(params = {}, options = {})
  req = build_request(:get_partner, params)
  req.send_request(options)
end

#get_profile_update_task(params = {}) ⇒ Types::GetProfileUpdateTaskResponse

Retrieves information about a specific profile update task.

Examples:

Request syntax with placeholder values


resp = client.get_profile_update_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.task_details.display_name #=> String
resp.task_details.description #=> String
resp.task_details.website_url #=> String
resp.task_details.logo_url #=> String
resp.task_details.primary_solution_type #=> String, one of "SOFTWARE_PRODUCTS", "CONSULTING_SERVICES", "PROFESSIONAL_SERVICES", "MANAGED_SERVICES", "HARDWARE_PRODUCTS", "COMMUNICATION_SERVICES", "VALUE_ADDED_RESALE_AWS_SERVICES", "TRAINING_SERVICES"
resp.task_details.industry_segments #=> Array
resp.task_details.industry_segments[0] #=> String, one of "AGRICULTURE_MINING", "BIOTECHNOLOGY", "BUSINESS_CONSUMER_SERVICES", "BUSINESS_SERV", "COMMUNICATIONS", "COMPUTER_HARDWARE", "COMPUTERS_ELECTRONICS", "COMPUTER_SOFTWARE", "CONSUMER_GOODS", "CONSUMER_RELATED", "EDUCATION", "ENERGY_UTILITIES", "FINANCIAL_SERVICES", "GAMING", "GOVERNMENT", "GOVERNMENT_EDUCATION_PUBLIC_SERVICES", "HEALTHCARE", "HEALTHCARE_PHARMACEUTICALS_BIOTECH", "INDUSTRIAL_ENERGY", "INTERNET_SPECIFIC", "LIFE_SCIENCES", "MANUFACTURING", "MEDIA_ENTERTAINMENT_LEISURE", "MEDIA_ENTERTAINMENT", "MEDICAL_HEALTH", "NON_PROFIT_ORGANIZATION", "OTHER", "PROFESSIONAL_SERVICES", "REAL_ESTATE_CONSTRUCTION", "RETAIL", "RETAIL_WHOLESALE_DISTRIBUTION", "SEMICONDUCTOR_ELECTR", "SOFTWARE_INTERNET", "TELECOMMUNICATIONS", "TRANSPORTATION_LOGISTICS", "TRAVEL_HOSPITALITY", "WHOLESALE_DISTRIBUTION"
resp.task_details.translation_source_locale #=> String
resp.task_details.localized_contents #=> Array
resp.task_details.localized_contents[0].display_name #=> String
resp.task_details.localized_contents[0].description #=> String
resp.task_details.localized_contents[0].website_url #=> String
resp.task_details.localized_contents[0].logo_url #=> String
resp.task_details.localized_contents[0].locale #=> String
resp.task_details.headquarters.country_code #=> String
resp.task_details.headquarters.subdivision_code #=> String
resp.started_at #=> Time
resp.status #=> String, one of "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.ended_at #=> Time
resp.error_detail_list #=> Array
resp.error_detail_list[0].locale #=> String
resp.error_detail_list[0].message #=> String
resp.error_detail_list[0].reason #=> String, one of "INVALID_CONTENT", "DUPLICATE_PROFILE", "INVALID_LOGO", "INVALID_LOGO_URL", "INVALID_LOGO_FILE", "INVALID_LOGO_SIZE", "INVALID_WEBSITE_URL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

Returns:

See Also:



1351
1352
1353
1354
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1351

def get_profile_update_task(params = {}, options = {})
  req = build_request(:get_profile_update_task, params)
  req.send_request(options)
end

#get_profile_visibility(params = {}) ⇒ Types::GetProfileVisibilityResponse

Retrieves the visibility settings for a partner profile, determining who can see the profile information.

Examples:

Request syntax with placeholder values


resp = client.get_profile_visibility({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.visibility #=> String, one of "PRIVATE", "PUBLIC"
resp.profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

Returns:

See Also:



1392
1393
1394
1395
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1392

def get_profile_visibility(params = {}, options = {})
  req = build_request(:get_profile_visibility, params)
  req.send_request(options)
end

#get_qualifications_association_details(params = {}) ⇒ Types::GetQualificationsAssociationDetailsResponse

Returns your current qualifications association status, the primary partner, and the full list of partners associated under the primary partner.

Examples:

Request syntax with placeholder values


resp = client.get_qualifications_association_details({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.status #=> String, one of "ASSOCIATED", "NOT_ASSOCIATED"
resp.primary_partner.profile_id #=> String
resp.primary_partner. #=> String
resp.associated_partners #=> Array
resp.associated_partners[0].profile_id #=> String
resp.associated_partners[0]. #=> String
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to look up the qualifications association. Valid values: AWS, Sandbox.

  • :identifier (required, String) —

    Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier.

Returns:

See Also:



1444
1445
1446
1447
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1444

def get_qualifications_association_details(params = {}, options = {})
  req = build_request(:get_qualifications_association_details, params)
  req.send_request(options)
end

#get_qualifications_association_task(params = {}) ⇒ Types::GetQualificationsAssociationTaskResponse

Retrieves the status and details of the most recent qualifications association task for your partner account. Use this operation to poll the progress of an association task initiated by StartQualificationsAssociationTask.

Examples:

Request syntax with placeholder values


resp = client.get_qualifications_association_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED"
resp.primary_partner.profile_id #=> String
resp.primary_partner. #=> String
resp.started_at #=> Time
resp.ended_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to look up the qualifications association task. Valid values: AWS, Sandbox.

  • :identifier (required, String) —

    Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier.

Returns:

See Also:



1497
1498
1499
1500
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1497

def get_qualifications_association_task(params = {}, options = {})
  req = build_request(:get_qualifications_association_task, params)
  req.send_request(options)
end

#get_qualifications_disassociation_task(params = {}) ⇒ Types::GetQualificationsDisassociationTaskResponse

Retrieves the status and details of the most recent qualifications disassociation task for your partner account. Use this operation to poll the progress of a disassociation task initiated by StartQualificationsDisassociationTask.

Examples:

Request syntax with placeholder values


resp = client.get_qualifications_disassociation_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED"
resp.associated_partner.profile_id #=> String
resp.associated_partner. #=> String
resp.started_at #=> Time
resp.ended_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to look up the qualifications disassociation task. Valid values: AWS, Sandbox.

  • :identifier (required, String) —

    Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier.

Returns:

See Also:



1550
1551
1552
1553
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1550

def get_qualifications_disassociation_task(params = {}, options = {})
  req = build_request(:get_qualifications_disassociation_task, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.get_verification({
  verification_type: "BUSINESS_VERIFICATION", # required, accepts BUSINESS_VERIFICATION, REGISTRANT_VERIFICATION
})

Response structure


resp.verification_type #=> String, one of "BUSINESS_VERIFICATION", "REGISTRANT_VERIFICATION"
resp.verification_status #=> String, one of "PENDING_CUSTOMER_ACTION", "IN_PROGRESS", "FAILED", "SUCCEEDED", "REJECTED"
resp.verification_status_reason #=> String
resp.verification_response_details.business_verification_response.business_verification_details.legal_name #=> String
resp.verification_response_details.business_verification_response.business_verification_details.registration_id #=> String
resp.verification_response_details.business_verification_response.business_verification_details.country_code #=> String
resp.verification_response_details.business_verification_response.business_verification_details.jurisdiction_of_incorporation #=> String
resp.verification_response_details.business_verification_response.completion_url #=> String
resp.verification_response_details.business_verification_response.completion_url_expires_at #=> Time
resp.verification_response_details.registrant_verification_response.completion_url #=> String
resp.verification_response_details.registrant_verification_response.completion_url_expires_at #=> Time
resp.started_at #=> Time
resp.completed_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verification_type (required, String) —

    The type of verification to retrieve information for. Valid values include business verification for company registration details and registrant verification for individual identity confirmation.

Returns:

See Also:



1599
1600
1601
1602
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1599

def get_verification(params = {}, options = {})
  req = build_request(:get_verification, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.list_connection_invitations({
  catalog: "Catalog", # required
  next_token: "NextToken",
  connection_type: "OPPORTUNITY_COLLABORATION", # accepts OPPORTUNITY_COLLABORATION, SUBSIDIARY
  max_results: 1,
  other_participant_identifiers: ["ParticipantIdentifier"],
  participant_type: "SENDER", # accepts SENDER, RECEIVER
  status: "PENDING", # accepts PENDING, ACCEPTED, REJECTED, CANCELED, EXPIRED
})

Response structure


resp.connection_invitation_summaries #=> Array
resp.connection_invitation_summaries[0].catalog #=> String
resp.connection_invitation_summaries[0].id #=> String
resp.connection_invitation_summaries[0].arn #=> String
resp.connection_invitation_summaries[0].connection_id #=> String
resp.connection_invitation_summaries[0].connection_type #=> String, one of "OPPORTUNITY_COLLABORATION", "SUBSIDIARY"
resp.connection_invitation_summaries[0].created_at #=> Time
resp.connection_invitation_summaries[0].updated_at #=> Time
resp.connection_invitation_summaries[0].expires_at #=> Time
resp.connection_invitation_summaries[0].other_participant_identifier #=> String
resp.connection_invitation_summaries[0].participant_type #=> String, one of "SENDER", "RECEIVER"
resp.connection_invitation_summaries[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :next_token (String) —

    The token for retrieving the next page of results in paginated responses.

  • :connection_type (String) —

    Filter results by connection type (e.g., reseller, distributor, technology partner).

  • :max_results (Integer) —

    The maximum number of connection invitations to return in a single response.

  • :other_participant_identifiers (Array<String>) —

    Filter results by specific participant identifiers.

  • :participant_type (String) —

    Filter results by participant type (inviter or invitee).

  • :status (String) —

    Filter results by invitation status (pending, accepted, rejected, canceled, expired).

Returns:

See Also:



1671
1672
1673
1674
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1671

def list_connection_invitations(params = {}, options = {})
  req = build_request(:list_connection_invitations, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  catalog: "Catalog", # required
  next_token: "NextToken",
  connection_type: "ConnectionTypeFilter",
  max_results: 1,
  other_participant_identifiers: ["ParticipantIdentifier"],
})

Response structure


resp.connection_summaries #=> Array
resp.connection_summaries[0].catalog #=> String
resp.connection_summaries[0].id #=> String
resp.connection_summaries[0].arn #=> String
resp.connection_summaries[0]. #=> String
resp.connection_summaries[0].updated_at #=> Time
resp.connection_summaries[0].connection_types #=> Hash
resp.connection_summaries[0].connection_types["ConnectionType"].status #=> String, one of "ACTIVE", "CANCELED"
resp.connection_summaries[0].connection_types["ConnectionType"].other_participant.partner_profile.id #=> String
resp.connection_summaries[0].connection_types["ConnectionType"].other_participant.partner_profile.name #=> String
resp.connection_summaries[0].connection_types["ConnectionType"].other_participant.seller_profile.id #=> String
resp.connection_summaries[0].connection_types["ConnectionType"].other_participant.seller_profile.name #=> String
resp.connection_summaries[0].connection_types["ConnectionType"].other_participant..name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :next_token (String) —

    The token for retrieving the next page of results in paginated responses.

  • :connection_type (String) —

    Filter results by connection type (e.g., reseller, distributor, technology partner).

  • :max_results (Integer) —

    The maximum number of connections to return in a single response.

  • :other_participant_identifiers (Array<String>) —

    Filter results by specific participant identifiers.

Returns:

See Also:



1734
1735
1736
1737
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1734

def list_connections(params = {}, options = {})
  req = build_request(:list_connections, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.list_partners({
  catalog: "Catalog", # required
  next_token: "NextToken",
})

Response structure


resp.partner_summary_list #=> Array
resp.partner_summary_list[0].catalog #=> String
resp.partner_summary_list[0].arn #=> String
resp.partner_summary_list[0].id #=> String
resp.partner_summary_list[0].legal_name #=> String
resp.partner_summary_list[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier to list partners from.

  • :next_token (String) —

    The token for retrieving the next page of results in paginated responses.

Returns:

See Also:



1777
1778
1779
1780
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1777

def list_partners(params = {}, options = {})
  req = build_request(:list_partners, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a specific AWS Partner Central Account resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # required
})

Response structure


resp.resource_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1810
1811
1812
1813
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1810

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_alliance_lead_contact(params = {}) ⇒ Types::PutAllianceLeadContactResponse

Creates or updates the alliance lead contact information for a partner account.

Examples:

Request syntax with placeholder values


resp = client.put_alliance_lead_contact({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  alliance_lead_contact: { # required
    first_name: "SensitiveUnicodeString", # required
    last_name: "SensitiveUnicodeString", # required
    email: "Email", # required
    business_title: "SensitiveUnicodeString", # required
  },
  email_verification_code: "EmailVerificationCode",
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.alliance_lead_contact.first_name #=> String
resp.alliance_lead_contact.last_name #=> String
resp.alliance_lead_contact.email #=> String
resp.alliance_lead_contact.business_title #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :alliance_lead_contact (required, Types::AllianceLeadContact) —

    The alliance lead contact information to set for the partner account.

  • :email_verification_code (String) —

    The verification code sent to the alliance lead contact's email to confirm the update.

Returns:

See Also:



1866
1867
1868
1869
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1866

def put_alliance_lead_contact(params = {}, options = {})
  req = build_request(:put_alliance_lead_contact, params)
  req.send_request(options)
end

#put_profile_visibility(params = {}) ⇒ Types::PutProfileVisibilityResponse

Sets the visibility level for a partner profile, controlling who can view the profile information.

Examples:

Request syntax with placeholder values


resp = client.put_profile_visibility({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  visibility: "PRIVATE", # required, accepts PRIVATE, PUBLIC
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.visibility #=> String, one of "PRIVATE", "PUBLIC"
resp.profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :visibility (required, String) —

    The visibility setting to apply to the partner profile.

Returns:

See Also:



1911
1912
1913
1914
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1911

def put_profile_visibility(params = {}, options = {})
  req = build_request(:put_profile_visibility, params)
  req.send_request(options)
end

#reject_connection_invitation(params = {}) ⇒ Types::RejectConnectionInvitationResponse

Rejects a connection invitation from another partner, declining the partnership request.

Examples:

Request syntax with placeholder values


resp = client.reject_connection_invitation({
  catalog: "Catalog", # required
  identifier: "ConnectionInvitationId", # required
  client_token: "ClientToken", # required
  reason: "RejectConnectionInvitationRequestReasonString",
})

Response structure


resp.catalog #=> String
resp.id #=> String
resp.arn #=> String
resp.connection_id #=> String
resp.connection_type #=> String, one of "OPPORTUNITY_COLLABORATION", "SUBSIDIARY"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.expires_at #=> Time
resp.other_participant_identifier #=> String
resp.participant_type #=> String, one of "SENDER", "RECEIVER"
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.invitation_message #=> String
resp.inviter_email #=> String
resp.inviter_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier where the connection invitation exists.

  • :identifier (required, String) —

    The unique identifier of the connection invitation to reject.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :reason (String) —

    The reason for rejecting the connection invitation.

Returns:

See Also:



1982
1983
1984
1985
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 1982

def reject_connection_invitation(params = {}, options = {})
  req = build_request(:reject_connection_invitation, params)
  req.send_request(options)
end

#send_email_verification_code(params = {}) ⇒ Struct

Sends an email verification code to the specified email address for account verification purposes.

Examples:

Request syntax with placeholder values


resp = client.send_email_verification_code({
  catalog: "Catalog", # required
  email: "Email", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :email (required, String) —

    The email address to send the verification code to.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2009
2010
2011
2012
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2009

def send_email_verification_code(params = {}, options = {})
  req = build_request(:send_email_verification_code, params)
  req.send_request(options)
end

#start_profile_update_task(params = {}) ⇒ Types::StartProfileUpdateTaskResponse

Initiates a profile update task to modify partner profile information asynchronously.

Examples:

Request syntax with placeholder values


resp = client.start_profile_update_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  task_details: { # required
    display_name: "UnicodeString", # required
    description: "TaskDetailsDescriptionString", # required
    website_url: "Url", # required
    logo_url: "Url", # required
    primary_solution_type: "SOFTWARE_PRODUCTS", # required, accepts SOFTWARE_PRODUCTS, CONSULTING_SERVICES, PROFESSIONAL_SERVICES, MANAGED_SERVICES, HARDWARE_PRODUCTS, COMMUNICATION_SERVICES, VALUE_ADDED_RESALE_AWS_SERVICES, TRAINING_SERVICES
    industry_segments: ["AGRICULTURE_MINING"], # required, accepts AGRICULTURE_MINING, BIOTECHNOLOGY, BUSINESS_CONSUMER_SERVICES, BUSINESS_SERV, COMMUNICATIONS, COMPUTER_HARDWARE, COMPUTERS_ELECTRONICS, COMPUTER_SOFTWARE, CONSUMER_GOODS, CONSUMER_RELATED, EDUCATION, ENERGY_UTILITIES, FINANCIAL_SERVICES, GAMING, GOVERNMENT, GOVERNMENT_EDUCATION_PUBLIC_SERVICES, HEALTHCARE, HEALTHCARE_PHARMACEUTICALS_BIOTECH, INDUSTRIAL_ENERGY, INTERNET_SPECIFIC, LIFE_SCIENCES, MANUFACTURING, MEDIA_ENTERTAINMENT_LEISURE, MEDIA_ENTERTAINMENT, MEDICAL_HEALTH, NON_PROFIT_ORGANIZATION, OTHER, PROFESSIONAL_SERVICES, REAL_ESTATE_CONSTRUCTION, RETAIL, RETAIL_WHOLESALE_DISTRIBUTION, SEMICONDUCTOR_ELECTR, SOFTWARE_INTERNET, TELECOMMUNICATIONS, TRANSPORTATION_LOGISTICS, TRAVEL_HOSPITALITY, WHOLESALE_DISTRIBUTION
    translation_source_locale: "Locale", # required
    localized_contents: [
      {
        display_name: "UnicodeString", # required
        description: "LocalizedContentDescriptionString", # required
        website_url: "Url", # required
        logo_url: "Url", # required
        locale: "Locale", # required
      },
    ],
    headquarters: {
      country_code: "CountryCode", # required
      subdivision_code: "SubdivisionCode", # required
    },
  },
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.task_details.display_name #=> String
resp.task_details.description #=> String
resp.task_details.website_url #=> String
resp.task_details.logo_url #=> String
resp.task_details.primary_solution_type #=> String, one of "SOFTWARE_PRODUCTS", "CONSULTING_SERVICES", "PROFESSIONAL_SERVICES", "MANAGED_SERVICES", "HARDWARE_PRODUCTS", "COMMUNICATION_SERVICES", "VALUE_ADDED_RESALE_AWS_SERVICES", "TRAINING_SERVICES"
resp.task_details.industry_segments #=> Array
resp.task_details.industry_segments[0] #=> String, one of "AGRICULTURE_MINING", "BIOTECHNOLOGY", "BUSINESS_CONSUMER_SERVICES", "BUSINESS_SERV", "COMMUNICATIONS", "COMPUTER_HARDWARE", "COMPUTERS_ELECTRONICS", "COMPUTER_SOFTWARE", "CONSUMER_GOODS", "CONSUMER_RELATED", "EDUCATION", "ENERGY_UTILITIES", "FINANCIAL_SERVICES", "GAMING", "GOVERNMENT", "GOVERNMENT_EDUCATION_PUBLIC_SERVICES", "HEALTHCARE", "HEALTHCARE_PHARMACEUTICALS_BIOTECH", "INDUSTRIAL_ENERGY", "INTERNET_SPECIFIC", "LIFE_SCIENCES", "MANUFACTURING", "MEDIA_ENTERTAINMENT_LEISURE", "MEDIA_ENTERTAINMENT", "MEDICAL_HEALTH", "NON_PROFIT_ORGANIZATION", "OTHER", "PROFESSIONAL_SERVICES", "REAL_ESTATE_CONSTRUCTION", "RETAIL", "RETAIL_WHOLESALE_DISTRIBUTION", "SEMICONDUCTOR_ELECTR", "SOFTWARE_INTERNET", "TELECOMMUNICATIONS", "TRANSPORTATION_LOGISTICS", "TRAVEL_HOSPITALITY", "WHOLESALE_DISTRIBUTION"
resp.task_details.translation_source_locale #=> String
resp.task_details.localized_contents #=> Array
resp.task_details.localized_contents[0].display_name #=> String
resp.task_details.localized_contents[0].description #=> String
resp.task_details.localized_contents[0].website_url #=> String
resp.task_details.localized_contents[0].logo_url #=> String
resp.task_details.localized_contents[0].locale #=> String
resp.task_details.headquarters.country_code #=> String
resp.task_details.headquarters.subdivision_code #=> String
resp.started_at #=> Time
resp.status #=> String, one of "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.ended_at #=> Time
resp.error_detail_list #=> Array
resp.error_detail_list[0].locale #=> String
resp.error_detail_list[0].message #=> String
resp.error_detail_list[0].reason #=> String, one of "INVALID_CONTENT", "DUPLICATE_PROFILE", "INVALID_LOGO", "INVALID_LOGO_URL", "INVALID_LOGO_FILE", "INVALID_LOGO_SIZE", "INVALID_WEBSITE_URL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :identifier (required, String) —

    The unique identifier of the partner account.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :task_details (required, Types::TaskDetails) —

    The details of the profile updates to be performed.

Returns:

See Also:



2109
2110
2111
2112
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2109

def start_profile_update_task(params = {}, options = {})
  req = build_request(:start_profile_update_task, params)
  req.send_request(options)
end

#start_qualifications_association_task(params = {}) ⇒ Types::StartQualificationsAssociationTaskResponse

Initiates an asynchronous task to associate your partner qualifications with a primary account. You must be a subsidiary of the primary account with an active subsidiary connection. Use GetQualificationsAssociationTask to monitor task progress.

Examples:

Request syntax with placeholder values


resp = client.start_qualifications_association_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  primary_partner: { # required
    profile_id: "PartnerProfileId",
    account_id: "AwsAccountId",
  },
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED"
resp.primary_partner.profile_id #=> String
resp.primary_partner. #=> String
resp.started_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to perform the qualifications association. Valid values: AWS, Sandbox.

  • :identifier (required, String) —

    Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :primary_partner (required, Types::QualificationsAssociationPartner) —

    The primary (acquiring) partner's profile and account identifier to associate qualifications with. You must provide at least one of ProfileId or AccountId. You cannot specify yourself as the primary partner.

Returns:

See Also:



2178
2179
2180
2181
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2178

def start_qualifications_association_task(params = {}, options = {})
  req = build_request(:start_qualifications_association_task, params)
  req.send_request(options)
end

#start_qualifications_disassociation_task(params = {}) ⇒ Types::StartQualificationsDisassociationTaskResponse

Initiates an asynchronous task to disassociate your partner qualifications from a primary account. You must currently be associated and cannot disassociate if you are the primary partner. Use GetQualificationsDisassociationTask to monitor task progress.

Examples:

Request syntax with placeholder values


resp = client.start_qualifications_disassociation_task({
  catalog: "Catalog", # required
  identifier: "PartnerIdentifier", # required
  client_token: "ClientToken",
  associated_partner: { # required
    profile_id: "PartnerProfileId",
    account_id: "AwsAccountId",
  },
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.id #=> String
resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED"
resp.associated_partner.profile_id #=> String
resp.associated_partner. #=> String
resp.started_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to perform the qualifications disassociation. Valid values: AWS, Sandbox.

  • :identifier (required, String) —

    Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :associated_partner (required, Types::QualificationsAssociationPartner) —

    The primary partner's profile and account identifier that you are currently associated with and will disassociate from. You must provide at least one of ProfileId or AccountId. The specified partner must match your current primary association.

Returns:

See Also:



2247
2248
2249
2250
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2247

def start_qualifications_disassociation_task(params = {}, options = {})
  req = build_request(:start_qualifications_disassociation_task, params)
  req.send_request(options)
end

#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.

Examples:

Request syntax with placeholder values


resp = client.start_verification({
  client_token: "ClientToken",
  verification_details: {
    business_verification_details: {
      legal_name: "LegalName", # required
      registration_id: "RegistrationId", # required
      country_code: "CountryCode", # required
      jurisdiction_of_incorporation: "JurisdictionCode",
    },
    registrant_verification_details: {
    },
  },
})

Response structure


resp.verification_type #=> String, one of "BUSINESS_VERIFICATION", "REGISTRANT_VERIFICATION"
resp.verification_status #=> String, one of "PENDING_CUSTOMER_ACTION", "IN_PROGRESS", "FAILED", "SUCCEEDED", "REJECTED"
resp.verification_status_reason #=> String
resp.verification_response_details.business_verification_response.business_verification_details.legal_name #=> String
resp.verification_response_details.business_verification_response.business_verification_details.registration_id #=> String
resp.verification_response_details.business_verification_response.business_verification_details.country_code #=> String
resp.verification_response_details.business_verification_response.business_verification_details.jurisdiction_of_incorporation #=> String
resp.verification_response_details.business_verification_response.completion_url #=> String
resp.verification_response_details.business_verification_response.completion_url_expires_at #=> Time
resp.verification_response_details.registrant_verification_response.completion_url #=> String
resp.verification_response_details.registrant_verification_response.completion_url_expires_at #=> Time
resp.started_at #=> Time
resp.completed_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This prevents duplicate verification processes from being started accidentally.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :verification_details (Types::VerificationDetails) —

    The specific details required for the verification process, including business information for business verification or personal information for registrant verification.

Returns:

See Also:



2315
2316
2317
2318
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2315

def start_verification(params = {}, options = {})
  req = build_request(:start_verification, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for a specified AWS Partner Central Account resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    A list of tags to add or update for the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2347
2348
2349
2350
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2347

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes specified tags from an AWS Partner Central Account resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2373
2374
2375
2376
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2373

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_connection_preferences(params = {}) ⇒ Types::UpdateConnectionPreferencesResponse

Updates the connection preferences for a partner account, modifying access settings and exclusions.

Examples:

Request syntax with placeholder values


resp = client.update_connection_preferences({
  catalog: "Catalog", # required
  revision: 1, # required
  access_type: "ALLOW_ALL", # required, accepts ALLOW_ALL, DENY_ALL, ALLOW_BY_DEFAULT_DENY_SOME
  excluded_participant_identifiers: ["ParticipantIdentifier"],
})

Response structure


resp.catalog #=> String
resp.arn #=> String
resp.access_type #=> String, one of "ALLOW_ALL", "DENY_ALL", "ALLOW_BY_DEFAULT_DENY_SOME"
resp.excluded_participant_ids #=> Array
resp.excluded_participant_ids[0] #=> String
resp.updated_at #=> Time
resp.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the partner account.

  • :revision (required, Integer) —

    The revision number of the connection preferences for optimistic locking.

  • :access_type (required, String) —

    The access type setting for connections (e.g., open, restricted, invitation-only).

  • :excluded_participant_identifiers (Array<String>) —

    The updated list of participant identifiers to exclude from connections.

Returns:

See Also:



2428
2429
2430
2431
 
# File 'gems/aws-sdk-partnercentralaccount/lib/aws-sdk-partnercentralaccount/client.rb', line 2428

def update_connection_preferences(params = {}, options = {})
  req = build_request(:update_connection_preferences, params)
  req.send_request(options)
end