Class: Aws::ConnectCampaignService::Client

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

Overview

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

client = Aws::ConnectCampaignService::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 Aws::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. This can be an 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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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 Aws::ClientStubs#stub_responses. See Aws::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) —

    A Bearer Token Provider. This can be an 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::ConnectCampaignService::EndpointProvider) —

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



467
468
469
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 467

def initialize(*args)
  super
end

Instance Method Details

#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.create_campaign({
  name: "CampaignName", # required
  connect_instance_id: "InstanceId", # required
  dialer_config: { # required
    progressive_dialer_config: {
      bandwidth_allocation: 1.0, # required
      dialing_capacity: 1.0,
    },
    predictive_dialer_config: {
      bandwidth_allocation: 1.0, # required
      dialing_capacity: 1.0,
    },
    agentless_dialer_config: {
      dialing_capacity: 1.0,
    },
  },
  outbound_call_config: { # required
    connect_contact_flow_id: "ContactFlowId", # required
    connect_source_phone_number: "SourcePhoneNumber",
    connect_queue_id: "QueueId",
    answer_machine_detection_config: {
      enable_answer_machine_detection: false, # required
      await_answer_machine_prompt: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of an Amazon Connect Campaign name.

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

  • :dialer_config (required, Types::DialerConfig) —

    The possible types of dialer config parameters

  • :outbound_call_config (required, Types::OutboundCallConfig) —

    The configuration used for outbound calls.

  • :tags (Hash<String,String>) —

    Tag map with key and value.

Returns:

See Also:



540
541
542
543
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 540

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

#delete_campaign(params = {}) ⇒ Struct

Deletes a campaign from the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.delete_campaign({
  id: "CampaignId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



562
563
564
565
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 562

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

#delete_connect_instance_config(params = {}) ⇒ Struct

Deletes a connect instance config from the specified AWS account.

Examples:

Request syntax with placeholder values


resp = client.delete_connect_instance_config({
  connect_instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



584
585
586
587
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 584

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

#delete_instance_onboarding_job(params = {}) ⇒ Struct

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.delete_instance_onboarding_job({
  connect_instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



607
608
609
610
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 607

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

#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse

Describes the specific campaign.

Examples:

Request syntax with placeholder values


resp = client.describe_campaign({
  id: "CampaignId", # required
})

Response structure


resp.campaign.id #=> String
resp.campaign.arn #=> String
resp.campaign.name #=> String
resp.campaign.connect_instance_id #=> String
resp.campaign.dialer_config.progressive_dialer_config.bandwidth_allocation #=> Float
resp.campaign.dialer_config.progressive_dialer_config.dialing_capacity #=> Float
resp.campaign.dialer_config.predictive_dialer_config.bandwidth_allocation #=> Float
resp.campaign.dialer_config.predictive_dialer_config.dialing_capacity #=> Float
resp.campaign.dialer_config.agentless_dialer_config.dialing_capacity #=> Float
resp.campaign.outbound_call_config.connect_contact_flow_id #=> String
resp.campaign.outbound_call_config.connect_source_phone_number #=> String
resp.campaign.outbound_call_config.connect_queue_id #=> String
resp.campaign.outbound_call_config.answer_machine_detection_config.enable_answer_machine_detection #=> Boolean
resp.campaign.outbound_call_config.answer_machine_detection_config.await_answer_machine_prompt #=> Boolean
resp.campaign.tags #=> Hash
resp.campaign.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

See Also:



650
651
652
653
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 650

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

#get_campaign_state(params = {}) ⇒ Types::GetCampaignStateResponse

Get state of a campaign for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.get_campaign_state({
  id: "CampaignId", # required
})

Response structure


resp.state #=> String, one of "Initialized", "Running", "Paused", "Stopped", "Failed"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

See Also:



678
679
680
681
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 678

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

#get_campaign_state_batch(params = {}) ⇒ Types::GetCampaignStateBatchResponse

Get state of campaigns for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.get_campaign_state_batch({
  campaign_ids: ["CampaignId"], # required
})

Response structure


resp.successful_requests #=> Array
resp.successful_requests[0].campaign_id #=> String
resp.successful_requests[0].state #=> String, one of "Initialized", "Running", "Paused", "Stopped", "Failed"
resp.failed_requests #=> Array
resp.failed_requests[0].campaign_id #=> String
resp.failed_requests[0].failure_code #=> String, one of "ResourceNotFound", "UnknownError"

Parameters:

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

    ({})

Options Hash (params):

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

    List of CampaignId

Returns:

See Also:



712
713
714
715
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 712

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

#get_connect_instance_config(params = {}) ⇒ Types::GetConnectInstanceConfigResponse

Get the specific Connect instance config.

Examples:

Request syntax with placeholder values


resp = client.get_connect_instance_config({
  connect_instance_id: "InstanceId", # required
})

Response structure


resp.connect_instance_config.connect_instance_id #=> String
resp.connect_instance_config.service_linked_role_arn #=> String
resp.connect_instance_config.encryption_config.enabled #=> Boolean
resp.connect_instance_config.encryption_config.encryption_type #=> String, one of "KMS"
resp.connect_instance_config.encryption_config.key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

Returns:

See Also:



744
745
746
747
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 744

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

#get_instance_onboarding_job_status(params = {}) ⇒ Types::GetInstanceOnboardingJobStatusResponse

Get the specific instance onboarding job status.

Examples:

Request syntax with placeholder values


resp = client.get_instance_onboarding_job_status({
  connect_instance_id: "InstanceId", # required
})

Response structure


resp.connect_instance_onboarding_job_status.connect_instance_id #=> String
resp.connect_instance_onboarding_job_status.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.connect_instance_onboarding_job_status.failure_code #=> String, one of "EVENT_BRIDGE_ACCESS_DENIED", "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "IAM_ACCESS_DENIED", "KMS_ACCESS_DENIED", "KMS_KEY_NOT_FOUND", "INTERNAL_FAILURE"

Parameters:

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

    ({})

Options Hash (params):

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

Returns:

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 774

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

#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse

Provides summary information about the campaigns under the specified Amazon Connect account.

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_campaigns({
  max_results: 1,
  next_token: "NextToken",
  filters: {
    instance_id_filter: {
      value: "InstanceId", # required
      operator: "Eq", # required, accepts Eq
    },
  },
})

Response structure


resp.next_token #=> String
resp.campaign_summary_list #=> Array
resp.campaign_summary_list[0].id #=> String
resp.campaign_summary_list[0].arn #=> String
resp.campaign_summary_list[0].name #=> String
resp.campaign_summary_list[0].connect_instance_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results.

  • :filters (Types::CampaignFilters) —

    Filter model by type

Returns:

See Also:



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

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

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

List tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    Arn

Returns:

See Also:



853
854
855
856
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 853

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

#pause_campaign(params = {}) ⇒ Struct

Pauses a campaign for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.pause_campaign({
  id: "CampaignId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



875
876
877
878
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 875

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

#put_dial_request_batch(params = {}) ⇒ Types::PutDialRequestBatchResponse

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.put_dial_request_batch({
  id: "CampaignId", # required
  dial_requests: [ # required
    {
      client_token: "ClientToken", # required
      phone_number: "DestinationPhoneNumber", # required
      expiration_time: Time.now, # required
      attributes: { # required
        "AttributeName" => "AttributeValue",
      },
    },
  ],
})

Response structure


resp.successful_requests #=> Array
resp.successful_requests[0].client_token #=> String
resp.successful_requests[0].id #=> String
resp.failed_requests #=> Array
resp.failed_requests[0].client_token #=> String
resp.failed_requests[0].id #=> String
resp.failed_requests[0].failure_code #=> String, one of "InvalidInput", "RequestThrottled", "UnknownError"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

  • :dial_requests (required, Array<Types::DialRequest>) —

    A list of dial requests.

Returns:

See Also:



924
925
926
927
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 924

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

#resume_campaign(params = {}) ⇒ Struct

Stops a campaign for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.resume_campaign({
  id: "CampaignId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



946
947
948
949
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 946

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

#start_campaign(params = {}) ⇒ Struct

Starts a campaign for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.start_campaign({
  id: "CampaignId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



968
969
970
971
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 968

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

#start_instance_onboarding_job(params = {}) ⇒ Types::StartInstanceOnboardingJobResponse

Onboard the specific Amazon Connect instance to Connect Campaigns.

Examples:

Request syntax with placeholder values


resp = client.start_instance_onboarding_job({
  connect_instance_id: "InstanceId", # required
  encryption_config: { # required
    enabled: false, # required
    encryption_type: "KMS", # accepts KMS
    key_arn: "EncryptionKey",
  },
})

Response structure


resp.connect_instance_onboarding_job_status.connect_instance_id #=> String
resp.connect_instance_onboarding_job_status.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.connect_instance_onboarding_job_status.failure_code #=> String, one of "EVENT_BRIDGE_ACCESS_DENIED", "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "IAM_ACCESS_DENIED", "KMS_ACCESS_DENIED", "KMS_KEY_NOT_FOUND", "INTERNAL_FAILURE"

Parameters:

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

    ({})

Options Hash (params):

  • :connect_instance_id (required, String) —

    Amazon Connect Instance Id

  • :encryption_config (required, Types::EncryptionConfig) —

    Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

Returns:

See Also:



1009
1010
1011
1012
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1009

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

#stop_campaign(params = {}) ⇒ Struct

Stops a campaign for the specified Amazon Connect account.

Examples:

Request syntax with placeholder values


resp = client.stop_campaign({
  id: "CampaignId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Tag a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    Arn

  • :tags (required, Hash<String,String>) —

    Tag map with key and value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1059
1060
1061
1062
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1059

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

#untag_resource(params = {}) ⇒ Struct

Untag a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    Arn

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

    List of tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1085
1086
1087
1088
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1085

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

#update_campaign_dialer_config(params = {}) ⇒ Struct

Updates the dialer config of a campaign. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.update_campaign_dialer_config({
  id: "CampaignId", # required
  dialer_config: { # required
    progressive_dialer_config: {
      bandwidth_allocation: 1.0, # required
      dialing_capacity: 1.0,
    },
    predictive_dialer_config: {
      bandwidth_allocation: 1.0, # required
      dialing_capacity: 1.0,
    },
    agentless_dialer_config: {
      dialing_capacity: 1.0,
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

  • :dialer_config (required, Types::DialerConfig) —

    The possible types of dialer config parameters

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1123
1124
1125
1126
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1123

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

#update_campaign_name(params = {}) ⇒ Struct

Updates the name of a campaign. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.update_campaign_name({
  id: "CampaignId", # required
  name: "CampaignName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

  • :name (required, String) —

    The name of an Amazon Connect Campaign name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1149
1150
1151
1152
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1149

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

#update_campaign_outbound_call_config(params = {}) ⇒ Struct

Updates the outbound call config of a campaign. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.update_campaign_outbound_call_config({
  id: "CampaignId", # required
  connect_contact_flow_id: "ContactFlowId",
  connect_source_phone_number: "SourcePhoneNumber",
  answer_machine_detection_config: {
    enable_answer_machine_detection: false, # required
    await_answer_machine_prompt: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    Identifier representing a Campaign

  • :connect_contact_flow_id (String) —

    The identifier of the contact flow for the outbound call.

  • :connect_source_phone_number (String) —

    The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

  • :answer_machine_detection_config (Types::AnswerMachineDetectionConfig) —

    Answering Machine Detection config

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1189
1190
1191
1192
 
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1189

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