Class: Aws::PartnerCentralChannel::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-partnercentralchannel/client.rb

Overview

An API client for PartnerCentralChannel. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::PartnerCentralChannel::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

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

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

  • :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` 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 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 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` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :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:

  • :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::PartnerCentralChannel::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PartnerCentralChannel::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 ‘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.



480
481
482
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 480

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2016
2017
2018
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 2016

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2019
2020
2021
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 2019

def errors_module
  Errors
end

Instance Method Details

#accept_channel_handshake(params = {}) ⇒ Types::AcceptChannelHandshakeResponse

Accepts a pending channel handshake request from another AWS account.

Examples:

Example: Example for AcceptChannelHandshake


resp = client.accept_channel_handshake({
  catalog: "AWS", 
  identifier: "ch-4fj3bd2o3vb91", 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
    status: "ACCEPTED", 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.channel_handshake_detail.id #=> String
resp.channel_handshake_detail.arn #=> String
resp.channel_handshake_detail.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the handshake request.

  • :identifier (required, String) —

    The unique identifier of the channel handshake to accept.

Returns:

See Also:



532
533
534
535
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 532

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1989

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PartnerCentralChannel')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-partnercentralchannel'
  context[:gem_version] = '1.8.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_channel_handshake(params = {}) ⇒ Types::CancelChannelHandshakeResponse

Cancels a pending channel handshake request.

Examples:

Example: Example for CancelChannelHandshake


resp = client.cancel_channel_handshake({
  catalog: "AWS", 
  identifier: "ch-4fj3bd2o3vb91", 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
    status: "CANCELED", 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.channel_handshake_detail.id #=> String
resp.channel_handshake_detail.arn #=> String
resp.channel_handshake_detail.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the handshake request.

  • :identifier (required, String) —

    The unique identifier of the channel handshake to cancel.

Returns:

See Also:



583
584
585
586
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 583

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

#create_channel_handshake(params = {}) ⇒ Types::CreateChannelHandshakeResponse

Creates a new channel handshake request to establish a partnership with another AWS account.

Examples:

Example: Example for CreateChannelHandshake - START_SERVICE_PERIOD with Minimum Notice Period


resp = client.create_channel_handshake({
  associated_resource_identifier: "rs-abc123def456g", 
  catalog: "AWS", 
  client_token: "clientToken", 
  handshake_type: "START_SERVICE_PERIOD", 
  payload: {
    start_service_period_payload: {
      minimum_notice_days: "14", 
      note: "Optional Note", 
      program_management_account_identifier: "pma-abcdef123456g", 
      service_period_type: "MINIMUM_NOTICE_PERIOD", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
  }, 
}

Example: Example for CreateChannelHandshake - START_SERVICE_PERIOD with Fixed Commitment Period


resp = client.create_channel_handshake({
  associated_resource_identifier: "rs-abc123def456g", 
  catalog: "AWS", 
  client_token: "clientToken", 
  handshake_type: "START_SERVICE_PERIOD", 
  payload: {
    start_service_period_payload: {
      end_date: Time.parse("2026-07-01T00:00:00Z"), 
      note: "Optional Note", 
      program_management_account_identifier: "pma-abcdef123456g", 
      service_period_type: "FIXED_COMMITMENT_PERIOD", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
  }, 
}

Example: Example for CreateChannelHandshake - REVOKE_SERVICE_PERIOD


resp = client.create_channel_handshake({
  associated_resource_identifier: "rs-abc123def456g", 
  catalog: "AWS", 
  client_token: "clientToken", 
  handshake_type: "REVOKE_SERVICE_PERIOD", 
  payload: {
    revoke_service_period_payload: {
      note: "Optional Note", 
      program_management_account_identifier: "pma-abcdef123456g", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
  }, 
}

Example: Example for CreateChannelHandshake - PROGRAM_MANAGEMENT_ACCOUNT


resp = client.create_channel_handshake({
  associated_resource_identifier: "pma-123abc456def7", 
  catalog: "AWS", 
  client_token: "clientToken", 
  handshake_type: "PROGRAM_MANAGEMENT_ACCOUNT", 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
  }, 
}

Request syntax with placeholder values


resp = client.create_channel_handshake({
  handshake_type: "START_SERVICE_PERIOD", # required, accepts START_SERVICE_PERIOD, REVOKE_SERVICE_PERIOD, PROGRAM_MANAGEMENT_ACCOUNT
  catalog: "Catalog", # required
  associated_resource_identifier: "AssociatedResourceIdentifier", # required
  payload: {
    start_service_period_payload: {
      program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
      note: "Note",
      service_period_type: "MINIMUM_NOTICE_PERIOD", # required, accepts MINIMUM_NOTICE_PERIOD, FIXED_COMMITMENT_PERIOD
      minimum_notice_days: "MinimumNoticeDays",
      end_date: Time.now,
    },
    revoke_service_period_payload: {
      program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
      note: "Note",
    },
  },
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.channel_handshake_detail.id #=> String
resp.channel_handshake_detail.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :handshake_type (required, String) —

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

  • :catalog (required, String) —

    The catalog identifier for the handshake request.

  • :associated_resource_identifier (required, String) —

    The identifier of the resource associated with this handshake.

  • :payload (Types::ChannelHandshakePayload) —

    The payload containing specific details for the handshake type.

  • :client_token (String) —

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

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

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

    Key-value pairs to associate with the channel handshake.

Returns:

See Also:



746
747
748
749
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 746

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

#create_program_management_account(params = {}) ⇒ Types::CreateProgramManagementAccountResponse

Creates a new program management account for managing partner relationships.

Examples:

Example: Example for CreateProgramManagementAccount


resp = client.({
  account_id: "111122223333", 
  catalog: "AWS", 
  client_token: "clientToken", 
  display_name: "TestDisplayName", 
  program: "SOLUTION_PROVIDER", 
})

resp.to_h outputs the following:
{
  program_management_account_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8", 
    id: "pma-u8ic702rtzng8", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  catalog: "Catalog", # required
  program: "SOLUTION_PROVIDER", # required, accepts SOLUTION_PROVIDER, DISTRIBUTION, DISTRIBUTION_SELLER
  display_name: "ProgramManagementAccountDisplayName", # required
  account_id: "AccountId", # required
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp..id #=> String
resp..arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the program management account.

  • :program (required, String) —

    The program type for the management account.

  • :display_name (required, String) —

    A human-readable name for the program management account.

  • :account_id (required, String) —

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

  • :client_token (String) —

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

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

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

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

Returns:

See Also:



824
825
826
827
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 824

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

#create_relationship(params = {}) ⇒ Types::CreateRelationshipResponse

Creates a new partner relationship between accounts.

Examples:

Example: Example for CreateRelationship


resp = client.create_relationship({
  associated_account_id: "987654321012", 
  association_type: "DOWNSTREAM_SELLER", 
  catalog: "AWS", 
  client_token: "clientToken", 
  display_name: "TestDisplayName", 
  program_management_account_identifier: "pma-u8ic702rtzng8", 
  resale_account_model: "END_CUSTOMER", 
  sector: "COMMERCIAL", 
})

resp.to_h outputs the following:
{
  relationship_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8/relationship/rs-l9o4fj3b5zb91", 
    id: "rs-l9o4fj3b5zb91", 
  }, 
}

Request syntax with placeholder values


resp = client.create_relationship({
  catalog: "Catalog", # required
  association_type: "DOWNSTREAM_SELLER", # required, accepts DOWNSTREAM_SELLER, END_CUSTOMER, INTERNAL
  program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
  associated_account_id: "AccountId", # required
  display_name: "RelationshipDisplayName", # required
  resale_account_model: "DISTRIBUTOR", # accepts DISTRIBUTOR, END_CUSTOMER, SOLUTION_PROVIDER
  sector: "COMMERCIAL", # required, accepts COMMERCIAL, GOVERNMENT, GOVERNMENT_EXCEPTION
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  requested_support_plan: {
    resold_enterprise: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      tam_location: "String", # required
      charge_account_id: "AccountId",
    },
    partner_led_support: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      provider: "DISTRIBUTOR", # accepts DISTRIBUTOR, DISTRIBUTION_SELLER
      tam_location: "String", # required
    },
    resold_unified_operations: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      tam_location: "String", # required
      charge_account_id: "AccountId",
    },
  },
})

Response structure


resp.relationship_detail.arn #=> String
resp.relationship_detail.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the relationship.

  • :association_type (required, String) —

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

  • :program_management_account_identifier (required, String) —

    The identifier of the program management account for this relationship.

  • :associated_account_id (required, String) —

    The AWS account ID to associate in this relationship.

  • :display_name (required, String) —

    A human-readable name for the relationship.

  • :resale_account_model (String) —

    The resale account model for the relationship.

  • :sector (required, String) —

    The business sector for the relationship.

  • :client_token (String) —

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

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

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

    Key-value pairs to associate with the relationship.

  • :requested_support_plan (Types::SupportPlan) —

    The support plan requested for this relationship.

Returns:

See Also:



938
939
940
941
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 938

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

#delete_program_management_account(params = {}) ⇒ Struct

Deletes a program management account.

Examples:

Example: Example for DeleteProgramManagementAccount


resp = client.({
  catalog: "AWS", 
  client_token: "clientToken", 
  identifier: "pma-u8ic702rtzng8", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the program management account.

  • :identifier (required, String) —

    The unique identifier of the program management account to delete.

  • :client_token (String) —

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



985
986
987
988
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 985

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

#delete_relationship(params = {}) ⇒ Struct

Deletes a partner relationship.

Examples:

Example: Example for DeleteRelationship


resp = client.delete_relationship({
  catalog: "AWS", 
  client_token: "clientToken", 
  identifier: "rs-l9o4fj3b5zb91", 
  program_management_account_identifier: "pma-u8ic702rtzng8", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_relationship({
  catalog: "Catalog", # required
  identifier: "RelationshipIdentifier", # required
  program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the relationship.

  • :identifier (required, String) —

    The unique identifier of the relationship to delete.

  • :program_management_account_identifier (required, String) —

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

  • :client_token (String) —

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1038
1039
1040
1041
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1038

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

#get_relationship(params = {}) ⇒ Types::GetRelationshipResponse

Retrieves details of a specific partner relationship.

Examples:

Example: Example for GetRelationship


resp = client.get_relationship({
  catalog: "AWS", 
  identifier: "rs-l9o4fj3b5zb91", 
  program_management_account_identifier: "pma-u8ic702rtzng8", 
})

resp.to_h outputs the following:
{
  relationship_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8/relationship/rs-l9o4fj3b5zb91", 
    associated_account_id: "987654321012", 
    association_type: "DOWNSTREAM_SELLER", 
    created_at: Time.parse("2024-04-29T16:18:16Z"), 
    display_name: "TestDisplayName", 
    id: "rs-l9o4fj3b5zb91", 
    program_management_account_id: "pma-u8ic702rtzng8", 
    resale_account_model: "END_CUSTOMER", 
    revision: "3", 
    sector: "COMMERCIAL", 
    updated_at: Time.parse("2024-05-02T16:18:16Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.get_relationship({
  catalog: "Catalog", # required
  program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
  identifier: "RelationshipIdentifier", # required
})

Response structure


resp.relationship_detail.arn #=> String
resp.relationship_detail.id #=> String
resp.relationship_detail.revision #=> String
resp.relationship_detail.catalog #=> String
resp.relationship_detail.association_type #=> String, one of "DOWNSTREAM_SELLER", "END_CUSTOMER", "INTERNAL"
resp.relationship_detail. #=> String
resp.relationship_detail. #=> String
resp.relationship_detail.display_name #=> String
resp.relationship_detail. #=> String, one of "DISTRIBUTOR", "END_CUSTOMER", "SOLUTION_PROVIDER"
resp.relationship_detail.sector #=> String, one of "COMMERCIAL", "GOVERNMENT", "GOVERNMENT_EXCEPTION"
resp.relationship_detail.created_at #=> Time
resp.relationship_detail.updated_at #=> Time
resp.relationship_detail.start_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the relationship.

  • :program_management_account_identifier (required, String) —

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

  • :identifier (required, String) —

    The unique identifier of the relationship to retrieve.

Returns:

See Also:



1113
1114
1115
1116
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1113

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

#list_channel_handshakes(params = {}) ⇒ Types::ListChannelHandshakesResponse

Lists channel handshakes based on specified criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: Example for ListChannelHandshakes - START_SERVICE_PERIOD


resp = client.list_channel_handshakes({
  associated_resource_identifiers: [
    "rs-123abc456def7", 
  ], 
  catalog: "AWS", 
  handshake_type: "START_SERVICE_PERIOD", 
  handshake_type_filters: {
    start_service_period_type_filters: {
      service_period_types: [
        "FIXED_COMMITMENT_PERIOD", 
      ], 
    }, 
  }, 
  handshake_type_sort: {
    start_service_period_type_sort: {
      sort_by: "UpdatedAt", 
      sort_order: "Descending", 
    }, 
  }, 
  participant_type: "SENDER", 
  statuses: [
    "ACCEPTED", 
  ], 
})

resp.to_h outputs the following:
{
  items: [
    {
      arn: "arn:aws:partnercentral:us-east-1:111122223333:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
      associated_resource_id: "rs-u8ic702rtfew1", 
      catalog: "AWS", 
      created_at: Time.parse("2025-04-29T16:18:16.000Z"), 
      detail: {
        start_service_period_handshake_detail: {
          minimum_notice_days: "14", 
          note: "Optional_Note", 
          service_period_type: "MINIMUM_NOTICE_PERIOD", 
        }, 
      }, 
      handshake_type: "START_SERVICE_PERIOD", 
      id: "ch-4fj3bd2o3vb91", 
      owner_account_id: "111122223333", 
      receiver_account_id: "333322221111", 
      sender_account_id: "111122224444", 
      status: "PENDING", 
      updated_at: Time.parse("2025-05-02T16:18:16.000Z"), 
    }, 
    {
      arn: "arn:aws:partnercentral:us-east-1:111122223333:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb92", 
      associated_resource_id: "rs-u8ic702rtfew1", 
      catalog: "AWS", 
      created_at: Time.parse("2025-02-28T16:18:16.000Z"), 
      detail: {
        start_service_period_handshake_detail: {
          end_date: Time.parse("2027-03-31T00:00:00.000Z"), 
          note: "Optional_Note", 
          service_period_type: "FIXED_COMMITMENT_PERIOD", 
          start_date: Time.parse("2025-02-02T00:00:00.000Z"), 
        }, 
      }, 
      handshake_type: "START_SERVICE_PERIOD", 
      id: "ch-4fj3bd2o3vb92", 
      owner_account_id: "111122223333", 
      receiver_account_id: "333322221111", 
      sender_account_id: "111122224444", 
      status: "PENDING", 
      updated_at: Time.parse("2025-03-02T16:18:16.000Z"), 
    }, 
  ], 
  next_token: "nextToken", 
}

Example: Example for ListChannelHandshakes - REVOKE_SERVICE_PERIOD


resp = client.list_channel_handshakes({
  associated_resource_identifiers: [
    "rs-123abc456def7", 
  ], 
  catalog: "AWS", 
  handshake_type: "REVOKE_SERVICE_PERIOD", 
  handshake_type_filters: {
    revoke_service_period_type_filters: {
      service_period_types: [
        "MINIMUM_NOTICE_PERIOD", 
      ], 
    }, 
  }, 
  handshake_type_sort: {
    revoke_service_period_type_sort: {
      sort_by: "UpdatedAt", 
      sort_order: "Descending", 
    }, 
  }, 
  participant_type: "SENDER", 
  statuses: [
    "ACCEPTED", 
  ], 
})

resp.to_h outputs the following:
{
  items: [
    {
      arn: "arn:aws:partnercentral:us-east-1:111122223333:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
      associated_resource_id: "rs-u8ic702rtfew1", 
      catalog: "AWS", 
      created_at: Time.parse("2025-04-29T16:18:16.000Z"), 
      detail: {
        revoke_service_period_handshake_detail: {
          minimum_notice_days: "14", 
          note: "Optional_Note", 
          service_period_type: "MINIMUM_NOTICE_PERIOD", 
        }, 
      }, 
      handshake_type: "REVOKE_SERVICE_PERIOD", 
      id: "ch-4fj3bd2o3vb91", 
      owner_account_id: "111122223333", 
      receiver_account_id: "333322221111", 
      sender_account_id: "111122224444", 
      status: "PENDING", 
      updated_at: Time.parse("2025-05-02T16:18:16.000Z"), 
    }, 
  ], 
  next_token: "nextToken", 
}

Example: Example for ListChannelHandshakes - PROGRAM_MANAGEMENT_ACCOUNT


resp = client.list_channel_handshakes({
  associated_resource_identifiers: [
    "pma-123abc456def7", 
  ], 
  catalog: "AWS", 
  handshake_type: "PROGRAM_MANAGEMENT_ACCOUNT", 
  handshake_type_filters: {
    program_management_account_type_filters: {
      programs: [
        "SOLUTION_PROVIDER", 
      ], 
    }, 
  }, 
  handshake_type_sort: {
    program_management_account_type_sort: {
      sort_by: "UpdatedAt", 
      sort_order: "Descending", 
    }, 
  }, 
  max_results: 20, 
  next_token: "nextToken", 
  participant_type: "SENDER", 
  statuses: [
    "ACCEPTED", 
  ], 
})

resp.to_h outputs the following:
{
  items: [
    {
      arn: "arn:aws:partnercentral:us-east-1:111122223333:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
      associated_resource_id: "pma-u8ic702rtfew1", 
      catalog: "AWS", 
      created_at: Time.parse("2025-02-28T16:18:16.000Z"), 
      detail: {
        program_management_account_handshake_detail: {
          program: "SOLUTION_PROVIDER", 
        }, 
      }, 
      handshake_type: "PROGRAM_MANAGEMENT_ACCOUNT", 
      id: "ch-4fj3bd2o3vb91", 
      owner_account_id: "111122223333", 
      receiver_account_id: "333322221111", 
      sender_account_id: "111122223333", 
      status: "PENDING", 
      updated_at: Time.parse("2025-03-02T16:18:16.000Z"), 
    }, 
  ], 
  next_token: "nextToken", 
}

Request syntax with placeholder values


resp = client.list_channel_handshakes({
  handshake_type: "START_SERVICE_PERIOD", # required, accepts START_SERVICE_PERIOD, REVOKE_SERVICE_PERIOD, PROGRAM_MANAGEMENT_ACCOUNT
  catalog: "Catalog", # required
  participant_type: "SENDER", # required, accepts SENDER, RECEIVER
  max_results: 1,
  statuses: ["PENDING"], # accepts PENDING, ACCEPTED, REJECTED, CANCELED, EXPIRED
  associated_resource_identifiers: ["AssociatedResourceIdentifier"],
  handshake_type_filters: {
    start_service_period_type_filters: {
      service_period_types: ["MINIMUM_NOTICE_PERIOD"], # accepts MINIMUM_NOTICE_PERIOD, FIXED_COMMITMENT_PERIOD
    },
    revoke_service_period_type_filters: {
      service_period_types: ["MINIMUM_NOTICE_PERIOD"], # accepts MINIMUM_NOTICE_PERIOD, FIXED_COMMITMENT_PERIOD
    },
    program_management_account_type_filters: {
      programs: ["SOLUTION_PROVIDER"], # accepts SOLUTION_PROVIDER, DISTRIBUTION, DISTRIBUTION_SELLER
    },
  },
  handshake_type_sort: {
    start_service_period_type_sort: {
      sort_order: "Ascending", # required, accepts Ascending, Descending
      sort_by: "UpdatedAt", # required, accepts UpdatedAt
    },
    revoke_service_period_type_sort: {
      sort_order: "Ascending", # required, accepts Ascending, Descending
      sort_by: "UpdatedAt", # required, accepts UpdatedAt
    },
    program_management_account_type_sort: {
      sort_order: "Ascending", # required, accepts Ascending, Descending
      sort_by: "UpdatedAt", # required, accepts UpdatedAt
    },
  },
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].arn #=> String
resp.items[0].catalog #=> String
resp.items[0].handshake_type #=> String, one of "START_SERVICE_PERIOD", "REVOKE_SERVICE_PERIOD", "PROGRAM_MANAGEMENT_ACCOUNT"
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].sender_display_name #=> String
resp.items[0]. #=> String
resp.items[0].associated_resource_id #=> String
resp.items[0].detail.start_service_period_handshake_detail.note #=> String
resp.items[0].detail.start_service_period_handshake_detail.service_period_type #=> String, one of "MINIMUM_NOTICE_PERIOD", "FIXED_COMMITMENT_PERIOD"
resp.items[0].detail.start_service_period_handshake_detail.minimum_notice_days #=> String
resp.items[0].detail.start_service_period_handshake_detail.start_date #=> Time
resp.items[0].detail.start_service_period_handshake_detail.end_date #=> Time
resp.items[0].detail.revoke_service_period_handshake_detail.note #=> String
resp.items[0].detail.revoke_service_period_handshake_detail.service_period_type #=> String, one of "MINIMUM_NOTICE_PERIOD", "FIXED_COMMITMENT_PERIOD"
resp.items[0].detail.revoke_service_period_handshake_detail.minimum_notice_days #=> String
resp.items[0].detail.revoke_service_period_handshake_detail.start_date #=> Time
resp.items[0].detail.revoke_service_period_handshake_detail.end_date #=> Time
resp.items[0].detail..program #=> String, one of "SOLUTION_PROVIDER", "DISTRIBUTION", "DISTRIBUTION_SELLER"
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :handshake_type (required, String) —

    Filter results by handshake type.

  • :catalog (required, String) —

    The catalog identifier to filter handshakes.

  • :participant_type (required, String) —

    Filter by participant type (sender or receiver).

  • :max_results (Integer) —

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

  • :statuses (Array<String>) —

    Filter results by handshake status.

  • :associated_resource_identifiers (Array<String>) —

    Filter by associated resource identifiers.

  • :handshake_type_filters (Types::ListChannelHandshakesTypeFilters) —

    Type-specific filters for handshakes.

  • :handshake_type_sort (Types::ListChannelHandshakesTypeSort) —

    Type-specific sorting options for handshakes.

  • :next_token (String) —

    Token for retrieving the next page of results.

Returns:

See Also:



1407
1408
1409
1410
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1407

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

#list_program_management_accounts(params = {}) ⇒ Types::ListProgramManagementAccountsResponse

Lists program management accounts based on specified criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: Example for ListProgramManagementAccounts


resp = client.list_program_management_accounts({
  account_ids: [
    "111122223333", 
  ], 
  catalog: "AWS", 
  display_names: [
    "TestDisplayName", 
  ], 
  max_results: 20, 
  programs: [
    "SOLUTION_PROVIDER", 
  ], 
  sort: {
    sort_by: "UpdatedAt", 
    sort_order: "Descending", 
  }, 
  statuses: [
    "PENDING", 
  ], 
})

resp.to_h outputs the following:
{
  items: [
    {
      account_id: "111122223333", 
      arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8", 
      catalog: "AWS", 
      created_at: Time.parse("2024-04-29T08:52:46.397Z"), 
      display_name: "TestDisplayName", 
      id: "pma-u8ic702rtzng8", 
      program: "SOLUTION_PROVIDER", 
      revision: "4", 
      status: "PENDING", 
      updated_at: Time.parse("2024-05-02T16:18:16.432Z"), 
    }, 
  ], 
  next_token: "nextToken", 
}

Request syntax with placeholder values


resp = client.list_program_management_accounts({
  catalog: "Catalog", # required
  max_results: 1,
  display_names: ["ProgramManagementAccountDisplayName"],
  programs: ["SOLUTION_PROVIDER"], # accepts SOLUTION_PROVIDER, DISTRIBUTION, DISTRIBUTION_SELLER
  account_ids: ["AccountId"],
  statuses: ["PENDING"], # accepts PENDING, ACTIVE, INACTIVE
  sort: {
    sort_order: "Ascending", # required, accepts Ascending, Descending
    sort_by: "UpdatedAt", # required, accepts UpdatedAt
  },
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].revision #=> String
resp.items[0].catalog #=> String
resp.items[0].program #=> String, one of "SOLUTION_PROVIDER", "DISTRIBUTION", "DISTRIBUTION_SELLER"
resp.items[0].display_name #=> String
resp.items[0]. #=> String
resp.items[0].arn #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].start_date #=> Time
resp.items[0].status #=> String, one of "PENDING", "ACTIVE", "INACTIVE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier to filter accounts.

  • :max_results (Integer) —

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

  • :display_names (Array<String>) —

    Filter by display names.

  • :programs (Array<String>) —

    Filter by program types.

  • :account_ids (Array<String>) —

    Filter by AWS account IDs.

  • :statuses (Array<String>) —

    Filter by program management account statuses.

  • :sort (Types::ListProgramManagementAccountsSortBase) —

    Sorting options for the results.

  • :next_token (String) —

    Token for retrieving the next page of results.

Returns:

See Also:



1524
1525
1526
1527
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1524

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

#list_relationships(params = {}) ⇒ Types::ListRelationshipsResponse

Lists partner relationships based on specified criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: Example for ListRelationships


resp = client.list_relationships({
  associated_account_ids: [
    "123456789012", 
  ], 
  association_types: [
    "DOWNSTREAM_SELLER", 
  ], 
  catalog: "AWS", 
  display_names: [
    "TestDisplayName", 
  ], 
  max_results: 100, 
  next_token: "nextToken", 
  program_management_account_identifiers: [
    "pma-u8ic702rtzng8", 
  ], 
  sort: {
    sort_by: "UpdatedAt", 
    sort_order: "Descending", 
  }, 
})

resp.to_h outputs the following:
{
  items: [
    {
      arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8/relationship/rs-l9o4fj3b5zb91", 
      associated_account_id: "987654321012", 
      association_type: "DOWNSTREAM_SELLER", 
      created_at: Time.parse("2024-04-29T16:18:16Z"), 
      display_name: "TestDisplayName", 
      id: "rs-l9o4fj3b5zb91", 
      program_management_account_id: "pma-u8ic702rtzng8", 
      revision: "3", 
      updated_at: Time.parse("2024-05-02T16:18:16Z"), 
    }, 
  ], 
  next_token: "nextToken", 
}

Request syntax with placeholder values


resp = client.list_relationships({
  catalog: "Catalog", # required
  max_results: 1,
  associated_account_ids: ["AccountId"],
  association_types: ["DOWNSTREAM_SELLER"], # accepts DOWNSTREAM_SELLER, END_CUSTOMER, INTERNAL
  display_names: ["RelationshipDisplayName"],
  program_management_account_identifiers: ["ProgramManagementAccountIdentifier"],
  sort: {
    sort_order: "Ascending", # required, accepts Ascending, Descending
    sort_by: "UpdatedAt", # required, accepts UpdatedAt
  },
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> String
resp.items[0].catalog #=> String
resp.items[0].association_type #=> String, one of "DOWNSTREAM_SELLER", "END_CUSTOMER", "INTERNAL"
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].display_name #=> String
resp.items[0].sector #=> String, one of "COMMERCIAL", "GOVERNMENT", "GOVERNMENT_EXCEPTION"
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].start_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier to filter relationships.

  • :max_results (Integer) —

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

  • :associated_account_ids (Array<String>) —

    Filter by associated AWS account IDs.

  • :association_types (Array<String>) —

    Filter by association types.

  • :display_names (Array<String>) —

    Filter by display names.

  • :program_management_account_identifiers (Array<String>) —

    Filter by program management account identifiers.

  • :sort (Types::ListRelationshipsSortBase) —

    Sorting options for the results.

  • :next_token (String) —

    Token for retrieving the next page of results.

Returns:

See Also:



1642
1643
1644
1645
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1642

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

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

Lists tags associated with a specific resource.

Examples:

Example: Example for ListTagsForResource


resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8", 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "ExampleKey", 
      value: "ExampleValue", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


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:



1689
1690
1691
1692
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1689

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

#reject_channel_handshake(params = {}) ⇒ Types::RejectChannelHandshakeResponse

Rejects a pending channel handshake request.

Examples:

Example: Example for RejectChannelHandshake


resp = client.reject_channel_handshake({
  catalog: "AWS", 
  identifier: "ch-4fj3bd2o3vb91", 
})

resp.to_h outputs the following:
{
  channel_handshake_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
    id: "ch-4fj3bd2o3vb91", 
    status: "REJECTED", 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.channel_handshake_detail.id #=> String
resp.channel_handshake_detail.arn #=> String
resp.channel_handshake_detail.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELED", "EXPIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the handshake request.

  • :identifier (required, String) —

    The unique identifier of the channel handshake to reject.

Returns:

See Also:



1740
1741
1742
1743
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1740

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for a specified resource.

Examples:

Example: Example for TagResource


resp = client.tag_resource({
  resource_arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8/relationship/rs-l9o4fj3b5zb91", 
  tags: [
    {
      key: "ExampleKey", 
      value: "ExampleValue", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableArn", # 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>) —

    Key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1788
1789
1790
1791
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1788

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a specified resource.

Examples:

Example: Example for UntagResource


resp = client.untag_resource({
  resource_arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/channel-handshake/ch-4fj3bd2o3vb91", 
  tag_keys: [
    "ExampleKey", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableArn", # 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>) —

    The keys of the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1828
1829
1830
1831
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1828

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

#update_program_management_account(params = {}) ⇒ Types::UpdateProgramManagementAccountResponse

Updates the properties of a program management account.

Examples:

Example: Example for UpdateProgramManagementAccount


resp = client.({
  catalog: "AWS", 
  display_name: "TestDisplayName", 
  identifier: "pma-u8ic702rtzng8", 
  revision: "3", 
})

resp.to_h outputs the following:
{
  program_management_account_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8", 
    display_name: "TestDisplayName", 
    id: "pma-u8ic702rtzng8", 
    revision: "4", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  catalog: "Catalog", # required
  identifier: "ProgramManagementAccountIdentifier", # required
  revision: "Revision",
  display_name: "ProgramManagementAccountDisplayName",
})

Response structure


resp..id #=> String
resp..arn #=> String
resp..revision #=> String
resp..display_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the program management account.

  • :identifier (required, String) —

    The unique identifier of the program management account to update.

  • :revision (String) —

    The current revision number of the program management account.

  • :display_name (String) —

    The new display name for the program management account.

Returns:

See Also:



1891
1892
1893
1894
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1891

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

#update_relationship(params = {}) ⇒ Types::UpdateRelationshipResponse

Updates the properties of a partner relationship.

Examples:

Example: Example for UpdateRelationship


resp = client.update_relationship({
  catalog: "AWS", 
  display_name: "TestDisplayName", 
  identifier: "rs-l9o4fj3b5zb91", 
  program_management_account_identifier: "pma-u8ic702rtzng8", 
  revision: "3", 
})

resp.to_h outputs the following:
{
  relationship_detail: {
    arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/program-management-account/pma-u8ic702rtzng8/relationship/rs-l9o4fj3b5zb91", 
    display_name: "TestDisplayName", 
    id: "rs-l9o4fj3b5zb91", 
    revision: "4", 
  }, 
}

Request syntax with placeholder values


resp = client.update_relationship({
  catalog: "Catalog", # required
  identifier: "RelationshipIdentifier", # required
  program_management_account_identifier: "ProgramManagementAccountIdentifier", # required
  revision: "Revision",
  display_name: "RelationshipDisplayName",
  requested_support_plan: {
    resold_enterprise: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      tam_location: "String", # required
      charge_account_id: "AccountId",
    },
    partner_led_support: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      provider: "DISTRIBUTOR", # accepts DISTRIBUTOR, DISTRIBUTION_SELLER
      tam_location: "String", # required
    },
    resold_unified_operations: {
      coverage: "ENTIRE_ORGANIZATION", # required, accepts ENTIRE_ORGANIZATION, MANAGEMENT_ACCOUNT_ONLY
      tam_location: "String", # required
      charge_account_id: "AccountId",
    },
  },
})

Response structure


resp.relationship_detail.arn #=> String
resp.relationship_detail.id #=> String
resp.relationship_detail.revision #=> String
resp.relationship_detail.display_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier for the relationship.

  • :identifier (required, String) —

    The unique identifier of the relationship to update.

  • :program_management_account_identifier (required, String) —

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

  • :revision (String) —

    The current revision number of the relationship.

  • :display_name (String) —

    The new display name for the relationship.

  • :requested_support_plan (Types::SupportPlan) —

    The updated support plan for the relationship.

Returns:

See Also:



1980
1981
1982
1983
 
# File 'lib/aws-sdk-partnercentralchannel/client.rb', line 1980

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


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

def waiter_names
  []
end