Client

connectcampaignservice

R Documentation

AmazonConnectCampaignService¶

Description¶

Provide APIs to create and manage Amazon Connect Campaigns.

Usage¶

connectcampaignservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- connectcampaignservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_campaign: Creates a campaign for the specified Amazon Connect account
delete_campaign: Deletes a campaign from the specified Amazon Connect account
delete_connect_instance_config: Deletes a connect instance config from the specified AWS account
delete_instance_onboarding_job: Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance
describe_campaign: Describes the specific campaign
get_campaign_state: Get state of a campaign for the specified Amazon Connect account
get_campaign_state_batch: Get state of campaigns for the specified Amazon Connect account
get_connect_instance_config: Get the specific Connect instance config
get_instance_onboarding_job_status: Get the specific instance onboarding job status
list_campaigns: Provides summary information about the campaigns under the specified Amazon Connect account
list_tags_for_resource: List tags for a resource
pause_campaign: Pauses a campaign for the specified Amazon Connect account
put_dial_request_batch: Creates dials requests for the specified campaign Amazon Connect account
resume_campaign: Stops a campaign for the specified Amazon Connect account
start_campaign: Starts a campaign for the specified Amazon Connect account
start_instance_onboarding_job: Onboard the specific Amazon Connect instance to Connect Campaigns
stop_campaign: Stops a campaign for the specified Amazon Connect account
tag_resource: Tag a resource
untag_resource: Untag a resource
update_campaign_dialer_config: Updates the dialer config of a campaign
update_campaign_name: Updates the name of a campaign
update_campaign_outbound_call_config: Updates the outbound call config of a campaign

Examples¶

## Not run: 
svc <- connectcampaignservice()
svc$create_campaign(
  Foo = 123
)

## End(Not run)