Package 'paws.customer.engagement'

Title: 'Amazon Web Services' Customer Engagement Services
Description: Interface to 'Amazon Web Services' customer engagement services, including 'Simple Email Service', 'Connect' contact center service, and more <https://aws.amazon.com/>.
Authors: David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph]
Maintainer: Dyfan Jones <[email protected]>
License: Apache License (>= 2.0)
Version: 0.7.0
Built: 2024-11-03 05:53:06 UTC
Source: https://github.com/paws-r/paws

Help Index


Amazon Connect Service

Description

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.

There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

Usage

connect(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 <- connect(
  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

activate_evaluation_form Activates an evaluation form in the specified Amazon Connect instance
associate_analytics_data_set This API is in preview release for Amazon Connect and is subject to change
associate_approved_origin This API is in preview release for Amazon Connect and is subject to change
associate_bot This API is in preview release for Amazon Connect and is subject to change
associate_default_vocabulary Associates an existing vocabulary as the default
associate_flow Associates a connect resource to a flow
associate_instance_storage_config This API is in preview release for Amazon Connect and is subject to change
associate_lambda_function This API is in preview release for Amazon Connect and is subject to change
associate_lex_bot This API is in preview release for Amazon Connect and is subject to change
associate_phone_number_contact_flow Associates a flow with a phone number claimed to your Amazon Connect instance
associate_queue_quick_connects This API is in preview release for Amazon Connect and is subject to change
associate_routing_profile_queues Associates a set of queues with a routing profile
associate_security_key This API is in preview release for Amazon Connect and is subject to change
associate_traffic_distribution_group_user Associates an agent with a traffic distribution group
associate_user_proficiencies >Associates a set of proficiencies with a user
batch_associate_analytics_data_set This API is in preview release for Amazon Connect and is subject to change
batch_disassociate_analytics_data_set This API is in preview release for Amazon Connect and is subject to change
batch_get_attached_file_metadata Allows you to retrieve metadata about multiple attached files on an associated resource
batch_get_flow_association Retrieve the flow associations for the given resources
batch_put_contact Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API
claim_phone_number Claims an available phone number to your Amazon Connect instance or traffic distribution group
complete_attached_file_upload Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API
create_agent_status This API is in preview release for Amazon Connect and is subject to change
create_contact_flow Creates a flow for the specified Amazon Connect instance
create_contact_flow_module Creates a flow module for the specified Amazon Connect instance
create_evaluation_form Creates an evaluation form in the specified Amazon Connect instance
create_hours_of_operation This API is in preview release for Amazon Connect and is subject to change
create_instance This API is in preview release for Amazon Connect and is subject to change
create_integration_association Creates an Amazon Web Services resource association with an Amazon Connect instance
create_participant Adds a new participant into an on-going chat contact
create_persistent_contact_association Enables rehydration of chats for the lifespan of a contact
create_predefined_attribute Creates a new predefined attribute for the specified Amazon Connect instance
create_prompt Creates a prompt
create_queue This API is in preview release for Amazon Connect and is subject to change
create_quick_connect Creates a quick connect for the specified Amazon Connect instance
create_routing_profile Creates a new routing profile
create_rule Creates a rule for the specified Amazon Connect instance
create_security_profile Creates a security profile
create_task_template Creates a new task template in the specified Amazon Connect instance
create_traffic_distribution_group Creates a traffic distribution group given an Amazon Connect instance that has been replicated
create_use_case Creates a use case for an integration association
create_user Creates a user account for the specified Amazon Connect instance
create_user_hierarchy_group Creates a new user hierarchy group
create_view Creates a new view with the possible status of SAVED or PUBLISHED
create_view_version Publishes a new version of the view identifier
create_vocabulary Creates a custom vocabulary associated with your Amazon Connect instance
deactivate_evaluation_form Deactivates an evaluation form in the specified Amazon Connect instance
delete_attached_file Deletes an attached file along with the underlying S3 Object
delete_contact_evaluation Deletes a contact evaluation in the specified Amazon Connect instance
delete_contact_flow Deletes a flow for the specified Amazon Connect instance
delete_contact_flow_module Deletes the specified flow module
delete_evaluation_form Deletes an evaluation form in the specified Amazon Connect instance
delete_hours_of_operation This API is in preview release for Amazon Connect and is subject to change
delete_instance This API is in preview release for Amazon Connect and is subject to change
delete_integration_association Deletes an Amazon Web Services resource association from an Amazon Connect instance
delete_predefined_attribute Deletes a predefined attribute from the specified Amazon Connect instance
delete_prompt Deletes a prompt
delete_queue Deletes a queue
delete_quick_connect Deletes a quick connect
delete_routing_profile Deletes a routing profile
delete_rule Deletes a rule for the specified Amazon Connect instance
delete_security_profile Deletes a security profile
delete_task_template Deletes the task template
delete_traffic_distribution_group Deletes a traffic distribution group
delete_use_case Deletes a use case from an integration association
delete_user Deletes a user account from the specified Amazon Connect instance
delete_user_hierarchy_group Deletes an existing user hierarchy group
delete_view Deletes the view entirely
delete_view_version Deletes the particular version specified in ViewVersion identifier
delete_vocabulary Deletes the vocabulary that has the given identifier
describe_agent_status This API is in preview release for Amazon Connect and is subject to change
describe_authentication_profile This API is in preview release for Amazon Connect and is subject to change
describe_contact This API is in preview release for Amazon Connect and is subject to change
describe_contact_evaluation Describes a contact evaluation in the specified Amazon Connect instance
describe_contact_flow Describes the specified flow
describe_contact_flow_module Describes the specified flow module
describe_evaluation_form Describes an evaluation form in the specified Amazon Connect instance
describe_hours_of_operation This API is in preview release for Amazon Connect and is subject to change
describe_instance This API is in preview release for Amazon Connect and is subject to change
describe_instance_attribute This API is in preview release for Amazon Connect and is subject to change
describe_instance_storage_config This API is in preview release for Amazon Connect and is subject to change
describe_phone_number Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group
describe_predefined_attribute Describes a predefined attribute for the specified Amazon Connect instance
describe_prompt Describes the prompt
describe_queue This API is in preview release for Amazon Connect and is subject to change
describe_quick_connect Describes the quick connect
describe_routing_profile Describes the specified routing profile
describe_rule Describes a rule for the specified Amazon Connect instance
describe_security_profile Gets basic information about the security profile
describe_traffic_distribution_group Gets details and status of a traffic distribution group
describe_user Describes the specified user
describe_user_hierarchy_group Describes the specified hierarchy group
describe_user_hierarchy_structure Describes the hierarchy structure of the specified Amazon Connect instance
describe_view Retrieves the view for the specified Amazon Connect instance and view identifier
describe_vocabulary Describes the specified vocabulary
disassociate_analytics_data_set This API is in preview release for Amazon Connect and is subject to change
disassociate_approved_origin This API is in preview release for Amazon Connect and is subject to change
disassociate_bot This API is in preview release for Amazon Connect and is subject to change
disassociate_flow Disassociates a connect resource from a flow
disassociate_instance_storage_config This API is in preview release for Amazon Connect and is subject to change
disassociate_lambda_function This API is in preview release for Amazon Connect and is subject to change
disassociate_lex_bot This API is in preview release for Amazon Connect and is subject to change
disassociate_phone_number_contact_flow Removes the flow association from a phone number claimed to your Amazon Connect instance
disassociate_queue_quick_connects This API is in preview release for Amazon Connect and is subject to change
disassociate_routing_profile_queues Disassociates a set of queues from a routing profile
disassociate_security_key This API is in preview release for Amazon Connect and is subject to change
disassociate_traffic_distribution_group_user Disassociates an agent from a traffic distribution group
disassociate_user_proficiencies Disassociates a set of proficiencies from a user
dismiss_user_contact Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact
get_attached_file Provides a pre-signed URL for download of an approved attached file
get_contact_attributes Retrieves the contact attributes for the specified contact
get_current_metric_data Gets the real-time metric data from the specified Amazon Connect instance
get_current_user_data Gets the real-time active user data from the specified Amazon Connect instance
get_federation_token Supports SAML sign-in for Amazon Connect
get_flow_association Retrieves the flow associated for a given resource
get_metric_data Gets historical metric data from the specified Amazon Connect instance
get_metric_data_v2 Gets metric data from the specified Amazon Connect instance
get_prompt_file Gets the prompt file
get_task_template Gets details about a specific task template in the specified Amazon Connect instance
get_traffic_distribution Retrieves the current traffic distribution for a given traffic distribution group
import_phone_number Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance
list_agent_statuses This API is in preview release for Amazon Connect and is subject to change
list_analytics_data_associations This API is in preview release for Amazon Connect and is subject to change
list_approved_origins This API is in preview release for Amazon Connect and is subject to change
list_authentication_profiles This API is in preview release for Amazon Connect and is subject to change
list_bots This API is in preview release for Amazon Connect and is subject to change
list_contact_evaluations Lists contact evaluations in the specified Amazon Connect instance
list_contact_flow_modules Provides information about the flow modules for the specified Amazon Connect instance
list_contact_flows Provides information about the flows for the specified Amazon Connect instance
list_contact_references This API is in preview release for Amazon Connect and is subject to change
list_default_vocabularies Lists the default vocabularies for the specified Amazon Connect instance
list_evaluation_forms Lists evaluation forms in the specified Amazon Connect instance
list_evaluation_form_versions Lists versions of an evaluation form in the specified Amazon Connect instance
list_flow_associations List the flow association based on the filters
list_hours_of_operations Provides information about the hours of operation for the specified Amazon Connect instance
list_instance_attributes This API is in preview release for Amazon Connect and is subject to change
list_instances This API is in preview release for Amazon Connect and is subject to change
list_instance_storage_configs This API is in preview release for Amazon Connect and is subject to change
list_integration_associations Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance
list_lambda_functions This API is in preview release for Amazon Connect and is subject to change
list_lex_bots This API is in preview release for Amazon Connect and is subject to change
list_phone_numbers Provides information about the phone numbers for the specified Amazon Connect instance
list_phone_numbers_v2 Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group
list_predefined_attributes Lists predefined attributes for the specified Amazon Connect instance
list_prompts Provides information about the prompts for the specified Amazon Connect instance
list_queue_quick_connects This API is in preview release for Amazon Connect and is subject to change
list_queues Provides information about the queues for the specified Amazon Connect instance
list_quick_connects Provides information about the quick connects for the specified Amazon Connect instance
list_realtime_contact_analysis_segments_v2 Provides a list of analysis segments for a real-time analysis session
list_routing_profile_queues Lists the queues associated with a routing profile
list_routing_profiles Provides summary information about the routing profiles for the specified Amazon Connect instance
list_rules List all rules for the specified Amazon Connect instance
list_security_keys This API is in preview release for Amazon Connect and is subject to change
list_security_profile_applications Returns a list of third-party applications in a specific security profile
list_security_profile_permissions Lists the permissions granted to a security profile
list_security_profiles Provides summary information about the security profiles for the specified Amazon Connect instance
list_tags_for_resource Lists the tags for the specified resource
list_task_templates Lists task templates for the specified Amazon Connect instance
list_traffic_distribution_groups Lists traffic distribution groups
list_traffic_distribution_group_users Lists traffic distribution group users
list_use_cases Lists the use cases for the integration association
list_user_hierarchy_groups Provides summary information about the hierarchy groups for the specified Amazon Connect instance
list_user_proficiencies Lists proficiencies associated with a user
list_users Provides summary information about the users for the specified Amazon Connect instance
list_views Returns views in the given instance
list_view_versions Returns all the available versions for the specified Amazon Connect instance and view identifier
monitor_contact Initiates silent monitoring of a contact
pause_contact Allows pausing an ongoing task contact
put_user_status Changes the current status of a user or agent in Amazon Connect
release_phone_number Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group
replicate_instance Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions
resume_contact Allows resuming a task contact in a paused state
resume_contact_recording When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both
search_agent_statuses Searches AgentStatuses in an Amazon Connect instance, with optional filtering
search_available_phone_numbers Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group
search_contact_flow_modules Searches the flow modules in an Amazon Connect instance, with optional filtering
search_contact_flows Searches the contact flows in an Amazon Connect instance, with optional filtering
search_contacts Searches contacts in an Amazon Connect instance
search_hours_of_operations Searches the hours of operation in an Amazon Connect instance, with optional filtering
search_predefined_attributes Searches predefined attributes that meet certain criteria
search_prompts Searches prompts in an Amazon Connect instance, with optional filtering
search_queues Searches queues in an Amazon Connect instance, with optional filtering
search_quick_connects Searches quick connects in an Amazon Connect instance, with optional filtering
search_resource_tags Searches tags used in an Amazon Connect instance using optional search criteria
search_routing_profiles Searches routing profiles in an Amazon Connect instance, with optional filtering
search_security_profiles Searches security profiles in an Amazon Connect instance, with optional filtering
search_user_hierarchy_groups Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering
search_users Searches users in an Amazon Connect instance, with optional filtering
search_vocabularies Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode
send_chat_integration_event Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect
start_attached_file_upload Provides a pre-signed Amazon S3 URL in response for uploading your content
start_chat_contact Initiates a flow to start a new chat for the customer
start_contact_evaluation Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact
start_contact_recording Starts recording the contact:
start_contact_streaming Initiates real-time message streaming for a new chat contact
start_outbound_voice_contact Places an outbound call to a contact, and then initiates the flow
start_task_contact Initiates a flow to start a new task contact
start_web_rtc_contact Places an inbound in-app, web, or video call to a contact, and then initiates the flow
stop_contact Ends the specified contact
stop_contact_recording Stops recording a call when a contact is being recorded
stop_contact_streaming Ends message streaming on a specified contact
submit_contact_evaluation Submits a contact evaluation in the specified Amazon Connect instance
suspend_contact_recording When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both
tag_contact Adds the specified tags to the contact resource
tag_resource Adds the specified tags to the specified resource
transfer_contact Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created
untag_contact Removes the specified tags from the contact resource
untag_resource Removes the specified tags from the specified resource
update_agent_status This API is in preview release for Amazon Connect and is subject to change
update_authentication_profile This API is in preview release for Amazon Connect and is subject to change
update_contact This API is in preview release for Amazon Connect and is subject to change
update_contact_attributes Creates or updates user-defined contact attributes associated with the specified contact
update_contact_evaluation Updates details about a contact evaluation in the specified Amazon Connect instance
update_contact_flow_content Updates the specified flow
update_contact_flow_metadata Updates metadata about specified flow
update_contact_flow_module_content Updates specified flow module for the specified Amazon Connect instance
update_contact_flow_module_metadata Updates metadata about specified flow module
update_contact_flow_name The name of the flow
update_contact_routing_data Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds)
update_contact_schedule Updates the scheduled time of a task contact that is already scheduled
update_evaluation_form Updates details about a specific evaluation form version in the specified Amazon Connect instance
update_hours_of_operation This API is in preview release for Amazon Connect and is subject to change
update_instance_attribute This API is in preview release for Amazon Connect and is subject to change
update_instance_storage_config This API is in preview release for Amazon Connect and is subject to change
update_participant_role_config Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness
update_phone_number Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region
update_phone_number_metadata Updates a phone number’s metadata
update_predefined_attribute Updates a predefined attribute for the specified Amazon Connect instance
update_prompt Updates a prompt
update_queue_hours_of_operation This API is in preview release for Amazon Connect and is subject to change
update_queue_max_contacts This API is in preview release for Amazon Connect and is subject to change
update_queue_name This API is in preview release for Amazon Connect and is subject to change
update_queue_outbound_caller_config This API is in preview release for Amazon Connect and is subject to change
update_queue_status This API is in preview release for Amazon Connect and is subject to change
update_quick_connect_config Updates the configuration settings for the specified quick connect
update_quick_connect_name Updates the name and description of a quick connect
update_routing_profile_agent_availability_timer Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time
update_routing_profile_concurrency Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile
update_routing_profile_default_outbound_queue Updates the default outbound queue of a routing profile
update_routing_profile_name Updates the name and description of a routing profile
update_routing_profile_queues Updates the properties associated with a set of queues for a routing profile
update_rule Updates a rule for the specified Amazon Connect instance
update_security_profile Updates a security profile
update_task_template Updates details about a specific task template in the specified Amazon Connect instance
update_traffic_distribution Updates the traffic distribution for a given traffic distribution group
update_user_hierarchy Assigns the specified hierarchy group to the specified user
update_user_hierarchy_group_name Updates the name of the user hierarchy group
update_user_hierarchy_structure Updates the user hierarchy structure: add, remove, and rename user hierarchy levels
update_user_identity_info Updates the identity information for the specified user
update_user_phone_config Updates the phone configuration settings for the specified user
update_user_proficiencies Updates the properties associated with the proficiencies of a user
update_user_routing_profile Assigns the specified routing profile to the specified user
update_user_security_profiles Assigns the specified security profiles to the specified user
update_view_content Updates the view content of the given view identifier in the specified Amazon Connect instance
update_view_metadata Updates the view metadata

Examples

## Not run: 
svc <- connect()
svc$activate_evaluation_form(
  Foo = 123
)

## End(Not run)

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)

Amazon Connect Cases

Description

With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.

Usage

connectcases(
  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 <- connectcases(
  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

batch_get_field Returns the description for the list of fields in the request parameters
batch_put_field_options Creates and updates a set of field options for a single select field in a Cases domain
create_case If you provide a value for PerformedBy
create_domain Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts
create_field Creates a field in the Cases domain
create_layout Creates a layout in the Cases domain
create_related_item Creates a related item (comments, tasks, and contacts) and associates it with a case
create_template Creates a template in the Cases domain
delete_domain Deletes a Cases domain
delete_field Deletes a field from a cases template
delete_layout Deletes a layout from a cases template
delete_template Deletes a cases template
get_case Returns information about a specific case if it exists
get_case_audit_events Returns the audit history about a specific case if it exists
get_case_event_configuration Returns the case event publishing configuration
get_domain Returns information about a specific domain if it exists
get_layout Returns the details for the requested layout
get_template Returns the details for the requested template
list_cases_for_contact Lists cases for a given contact
list_domains Lists all cases domains in the Amazon Web Services account
list_field_options Lists all of the field options for a field identifier in the domain
list_fields Lists all fields in a Cases domain
list_layouts Lists all layouts in the given cases domain
list_tags_for_resource Lists tags for a resource
list_templates Lists all of the templates in a Cases domain
put_case_event_configuration Adds case event publishing configuration
search_cases Searches for cases within their associated Cases domain
search_related_items Searches for related items that are associated with a case
tag_resource Adds tags to a resource
untag_resource Untags a resource
update_case If you provide a value for PerformedBy
update_field Updates the properties of an existing field
update_layout Updates the attributes of an existing layout
update_template Updates the attributes of an existing template

Examples

## Not run: 
svc <- connectcases()
svc$batch_get_field(
  Foo = 123
)

## End(Not run)

Amazon Connect Contact Lens

Description

Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts.

Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using speech analytics in the Amazon Connect Administrator Guide.

Usage

connectcontactlens(
  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 <- connectcontactlens(
  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

list_realtime_contact_analysis_segments Provides a list of analysis segments for a real-time analysis session

Examples

## Not run: 
svc <- connectcontactlens()
svc$list_realtime_contact_analysis_segments(
  Foo = 123
)

## End(Not run)

Amazon Connect Participant Service

Description

Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.

Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.

Usage

connectparticipant(
  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 <- connectparticipant(
  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

complete_attachment_upload Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API
create_participant_connection Creates the participant's connection
describe_view Retrieves the view for the specified view token
disconnect_participant Disconnects a participant
get_attachment Provides a pre-signed URL for download of a completed attachment
get_transcript Retrieves a transcript of the session, including details about any attachments
send_event The application/vnd
send_message Sends a message
start_attachment_upload Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3

Examples

## Not run: 
svc <- connectparticipant()
svc$complete_attachment_upload(
  Foo = 123
)

## End(Not run)

Amazon Connect Wisdom Service

Description

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

Usage

connectwisdomservice(
  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 <- connectwisdomservice(
  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_assistant Creates an Amazon Connect Wisdom assistant
create_assistant_association Creates an association between an Amazon Connect Wisdom assistant and another resource
create_content Creates Wisdom content
create_knowledge_base Creates a knowledge base
create_quick_response Creates a Wisdom quick response
create_session Creates a session
delete_assistant Deletes an assistant
delete_assistant_association Deletes an assistant association
delete_content Deletes the content
delete_import_job Deletes the quick response import job
delete_knowledge_base Deletes the knowledge base
delete_quick_response Deletes a quick response
get_assistant Retrieves information about an assistant
get_assistant_association Retrieves information about an assistant association
get_content Retrieves content, including a pre-signed URL to download the content
get_content_summary Retrieves summary information about the content
get_import_job Retrieves the started import job
get_knowledge_base Retrieves information about the knowledge base
get_quick_response Retrieves the quick response
get_recommendations Retrieves recommendations for the specified session
get_session Retrieves information for a specified session
list_assistant_associations Lists information about assistant associations
list_assistants Lists information about assistants
list_contents Lists the content
list_import_jobs Lists information about import jobs
list_knowledge_bases Lists the knowledge bases
list_quick_responses Lists information about quick response
list_tags_for_resource Lists the tags for the specified resource
notify_recommendations_received Removes the specified recommendations from the specified assistant's queue of newly available recommendations
query_assistant Performs a manual search against the specified assistant
remove_knowledge_base_template_uri Removes a URI template from a knowledge base
search_content Searches for content in a specified knowledge base
search_quick_responses Searches existing Wisdom quick responses in a Wisdom knowledge base
search_sessions Searches for sessions
start_content_upload Get a URL to upload content to a knowledge base
start_import_job Start an asynchronous job to import Wisdom resources from an uploaded source file
tag_resource Adds the specified tags to the specified resource
untag_resource Removes the specified tags from the specified resource
update_content Updates information about the content
update_knowledge_base_template_uri Updates the template URI of a knowledge base
update_quick_response Updates an existing Wisdom quick response

Examples

## Not run: 
svc <- connectwisdomservice()
svc$create_assistant(
  Foo = 123
)

## End(Not run)

Amazon Connect Customer Profiles

Description

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.

For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles in the Amazon Connect Administrator's Guide.

Usage

customerprofiles(
  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 <- customerprofiles(
  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

add_profile_key Associates a new key value with a specific profile, such as a Contact Record ContactId
create_calculated_attribute_definition Creates a new calculated attribute definition
create_domain Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys
create_event_stream Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles
create_integration_workflow Creates an integration workflow
create_profile Creates a standard profile
delete_calculated_attribute_definition Deletes an existing calculated attribute definition
delete_domain Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects
delete_event_stream Disables and deletes the specified event stream
delete_integration Removes an integration from a specific domain
delete_profile Deletes the standard customer profile and all data pertaining to the profile
delete_profile_key Removes a searchable key from a customer profile
delete_profile_object Removes an object associated with a profile of a given ProfileObjectType
delete_profile_object_type Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type
delete_workflow Deletes the specified workflow and all its corresponding resources
detect_profile_object_type The process of detecting profile object type mapping by using given objects
get_auto_merging_preview Tests the auto-merging settings of your Identity Resolution Job without merging your data
get_calculated_attribute_definition Provides more information on a calculated attribute definition for Customer Profiles
get_calculated_attribute_for_profile Retrieve a calculated attribute for a customer profile
get_domain Returns information about a specific domain
get_event_stream Returns information about the specified event stream in a specific domain
get_identity_resolution_job Returns information about an Identity Resolution Job in a specific domain
get_integration Returns an integration for a domain
get_matches Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true
get_profile_object_type Returns the object types for a specific domain
get_profile_object_type_template Returns the template information for a specific object type
get_similar_profiles Returns a set of profiles that belong to the same matching group using the matchId or profileId
get_workflow Get details of specified workflow
get_workflow_steps Get granular list of steps in workflow
list_account_integrations Lists all of the integrations associated to a specific URI in the AWS account
list_calculated_attribute_definitions Lists calculated attribute definitions for Customer Profiles
list_calculated_attributes_for_profile Retrieve a list of calculated attributes for a customer profile
list_domains Returns a list of all the domains for an AWS account that have been created
list_event_streams Returns a list of all the event streams in a specific domain
list_identity_resolution_jobs Lists all of the Identity Resolution Jobs in your domain
list_integrations Lists all of the integrations in your domain
list_profile_objects Returns a list of objects associated with a profile of a given ProfileObjectType
list_profile_object_types Lists all of the templates available within the service
list_profile_object_type_templates Lists all of the template information for object types
list_rule_based_matches Returns a set of MatchIds that belong to the given domain
list_tags_for_resource Displays the tags associated with an Amazon Connect Customer Profiles resource
list_workflows Query to list all workflows
merge_profiles Runs an AWS Lambda job that does the following:
put_integration Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect
put_profile_object Adds additional objects to customer profiles of a given ObjectType
put_profile_object_type Defines a ProfileObjectType
search_profiles Searches for profiles within a specific domain using one or more predefined search keys (e
tag_resource Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource
untag_resource Removes one or more tags from the specified Amazon Connect Customer Profiles resource
update_calculated_attribute_definition Updates an existing calculated attribute definition
update_domain Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key
update_profile Updates the properties of a profile

Examples

## Not run: 
svc <- customerprofiles()
svc$add_profile_key(
  Foo = 123
)

## End(Not run)

Amazon Pinpoint

Description

Doc Engage API - Amazon Pinpoint API

Usage

pinpoint(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 <- pinpoint(
  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_app Creates an application
create_campaign Creates a new campaign for an application or updates the settings of an existing campaign for an application
create_email_template Creates a message template for messages that are sent through the email channel
create_export_job Creates an export job for an application
create_import_job Creates an import job for an application
create_in_app_template Creates a new message template for messages using the in-app message channel
create_journey Creates a journey for an application
create_push_template Creates a message template for messages that are sent through a push notification channel
create_recommender_configuration Creates an Amazon Pinpoint configuration for a recommender model
create_segment Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application
create_sms_template Creates a message template for messages that are sent through the SMS channel
create_voice_template Creates a message template for messages that are sent through the voice channel
delete_adm_channel Disables the ADM channel for an application and deletes any existing settings for the channel
delete_apns_channel Disables the APNs channel for an application and deletes any existing settings for the channel
delete_apns_sandbox_channel Disables the APNs sandbox channel for an application and deletes any existing settings for the channel
delete_apns_voip_channel Disables the APNs VoIP channel for an application and deletes any existing settings for the channel
delete_apns_voip_sandbox_channel Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel
delete_app Deletes an application
delete_baidu_channel Disables the Baidu channel for an application and deletes any existing settings for the channel
delete_campaign Deletes a campaign from an application
delete_email_channel Disables the email channel for an application and deletes any existing settings for the channel
delete_email_template Deletes a message template for messages that were sent through the email channel
delete_endpoint Deletes an endpoint from an application
delete_event_stream Deletes the event stream for an application
delete_gcm_channel Disables the GCM channel for an application and deletes any existing settings for the channel
delete_in_app_template Deletes a message template for messages sent using the in-app message channel
delete_journey Deletes a journey from an application
delete_push_template Deletes a message template for messages that were sent through a push notification channel
delete_recommender_configuration Deletes an Amazon Pinpoint configuration for a recommender model
delete_segment Deletes a segment from an application
delete_sms_channel Disables the SMS channel for an application and deletes any existing settings for the channel
delete_sms_template Deletes a message template for messages that were sent through the SMS channel
delete_user_endpoints Deletes all the endpoints that are associated with a specific user ID
delete_voice_channel Disables the voice channel for an application and deletes any existing settings for the channel
delete_voice_template Deletes a message template for messages that were sent through the voice channel
get_adm_channel Retrieves information about the status and settings of the ADM channel for an application
get_apns_channel Retrieves information about the status and settings of the APNs channel for an application
get_apns_sandbox_channel Retrieves information about the status and settings of the APNs sandbox channel for an application
get_apns_voip_channel Retrieves information about the status and settings of the APNs VoIP channel for an application
get_apns_voip_sandbox_channel Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application
get_app Retrieves information about an application
get_application_date_range_kpi Retrieves (queries) pre-aggregated data for a standard metric that applies to an application
get_application_settings Retrieves information about the settings for an application
get_apps Retrieves information about all the applications that are associated with your Amazon Pinpoint account
get_baidu_channel Retrieves information about the status and settings of the Baidu channel for an application
get_campaign Retrieves information about the status, configuration, and other settings for a campaign
get_campaign_activities Retrieves information about all the activities for a campaign
get_campaign_date_range_kpi Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign
get_campaigns Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application
get_campaign_version Retrieves information about the status, configuration, and other settings for a specific version of a campaign
get_campaign_versions Retrieves information about the status, configuration, and other settings for all versions of a campaign
get_channels Retrieves information about the history and status of each channel for an application
get_email_channel Retrieves information about the status and settings of the email channel for an application
get_email_template Retrieves the content and settings of a message template for messages that are sent through the email channel
get_endpoint Retrieves information about the settings and attributes of a specific endpoint for an application
get_event_stream Retrieves information about the event stream settings for an application
get_export_job Retrieves information about the status and settings of a specific export job for an application
get_export_jobs Retrieves information about the status and settings of all the export jobs for an application
get_gcm_channel Retrieves information about the status and settings of the GCM channel for an application
get_import_job Retrieves information about the status and settings of a specific import job for an application
get_import_jobs Retrieves information about the status and settings of all the import jobs for an application
get_in_app_messages Retrieves the in-app messages targeted for the provided endpoint ID
get_in_app_template Retrieves the content and settings of a message template for messages sent through the in-app channel
get_journey Retrieves information about the status, configuration, and other settings for a journey
get_journey_date_range_kpi Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey
get_journey_execution_activity_metrics Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity
get_journey_execution_metrics Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey
get_journey_run_execution_activity_metrics Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity
get_journey_run_execution_metrics Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey
get_journey_runs Provides information about the runs of a journey
get_push_template Retrieves the content and settings of a message template for messages that are sent through a push notification channel
get_recommender_configuration Retrieves information about an Amazon Pinpoint configuration for a recommender model
get_recommender_configurations Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account
get_segment Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application
get_segment_export_jobs Retrieves information about the status and settings of the export jobs for a segment
get_segment_import_jobs Retrieves information about the status and settings of the import jobs for a segment
get_segments Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application
get_segment_version Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application
get_segment_versions Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application
get_sms_channel Retrieves information about the status and settings of the SMS channel for an application
get_sms_template Retrieves the content and settings of a message template for messages that are sent through the SMS channel
get_user_endpoints Retrieves information about all the endpoints that are associated with a specific user ID
get_voice_channel Retrieves information about the status and settings of the voice channel for an application
get_voice_template Retrieves the content and settings of a message template for messages that are sent through the voice channel
list_journeys Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application
list_tags_for_resource Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment
list_templates Retrieves information about all the message templates that are associated with your Amazon Pinpoint account
list_template_versions Retrieves information about all the versions of a specific message template
phone_number_validate Retrieves information about a phone number
put_events Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with
put_event_stream Creates a new event stream for an application or updates the settings of an existing event stream for an application
remove_attributes Removes one or more custom attributes, of the same attribute type, from the application
send_messages Creates and sends a direct message
send_otp_message Send an OTP message
send_users_messages Creates and sends a message to a list of users
tag_resource Adds one or more tags (keys and values) to an application, campaign, message template, or segment
untag_resource Removes one or more tags (keys and values) from an application, campaign, message template, or segment
update_adm_channel Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application
update_apns_channel Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application
update_apns_sandbox_channel Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application
update_apns_voip_channel Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application
update_apns_voip_sandbox_channel Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application
update_application_settings Updates the settings for an application
update_baidu_channel Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application
update_campaign Updates the configuration and other settings for a campaign
update_email_channel Enables the email channel for an application or updates the status and settings of the email channel for an application
update_email_template Updates an existing message template for messages that are sent through the email channel
update_endpoint Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application
update_endpoints_batch Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application
update_gcm_channel Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application
update_in_app_template Updates an existing message template for messages sent through the in-app message channel
update_journey Updates the configuration and other settings for a journey
update_journey_state Cancels (stops) an active journey
update_push_template Updates an existing message template for messages that are sent through a push notification channel
update_recommender_configuration Updates an Amazon Pinpoint configuration for a recommender model
update_segment Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application
update_sms_channel Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application
update_sms_template Updates an existing message template for messages that are sent through the SMS channel
update_template_active_version Changes the status of a specific version of a message template to active
update_voice_channel Enables the voice channel for an application or updates the status and settings of the voice channel for an application
update_voice_template Updates an existing message template for messages that are sent through the voice channel
verify_otp_message Verify an OTP

Examples

## Not run: 
svc <- pinpoint()
# The following example gets activity execution metrics for a single run
# of a journey.
svc$get_journey_run_execution_activity_metrics(
  ApplicationId = "11111111112222222222333333333344",
  JourneyId = "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  RunId = "99999999998888888888777777777766",
  JourneyActivityId = "AAAAAAAAAA"
)

## End(Not run)

Amazon Pinpoint Email Service

Description

Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

Usage

pinpointemail(
  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 <- pinpointemail(
  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_configuration_set Create a configuration set
create_configuration_set_event_destination Create an event destination
create_dedicated_ip_pool Create a new pool of dedicated IP addresses
create_deliverability_test_report Create a new predictive inbox placement test
create_email_identity Verifies an email identity for use with Amazon Pinpoint
delete_configuration_set Delete an existing configuration set
delete_configuration_set_event_destination Delete an event destination
delete_dedicated_ip_pool Delete a dedicated IP pool
delete_email_identity Deletes an email identity that you previously verified for use with Amazon Pinpoint
get_account Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region
get_blacklist_reports Retrieve a list of the blacklists that your dedicated IP addresses appear on
get_configuration_set Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more
get_configuration_set_event_destinations Retrieve a list of event destinations that are associated with a configuration set
get_dedicated_ip Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address
get_dedicated_ips List the dedicated IP addresses that are associated with your Amazon Pinpoint account
get_deliverability_dashboard_options Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account
get_deliverability_test_report Retrieve the results of a predictive inbox placement test
get_domain_deliverability_campaign Retrieve all the deliverability data for a specific campaign
get_domain_statistics_report Retrieve inbox placement and engagement rates for the domains that you use to send email
get_email_identity Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings
list_configuration_sets List all of the configuration sets associated with your Amazon Pinpoint account in the current region
list_dedicated_ip_pools List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region
list_deliverability_test_reports Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses
list_domain_deliverability_campaigns Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range
list_email_identities Returns a list of all of the email identities that are associated with your Amazon Pinpoint account
list_tags_for_resource Retrieve a list of the tags (keys and values) that are associated with a specified resource
put_account_dedicated_ip_warmup_attributes Enable or disable the automatic warm-up feature for dedicated IP addresses
put_account_sending_attributes Enable or disable the ability of your account to send email
put_configuration_set_delivery_options Associate a configuration set with a dedicated IP pool
put_configuration_set_reputation_options Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region
put_configuration_set_sending_options Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region
put_configuration_set_tracking_options Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint
put_dedicated_ip_in_pool Move a dedicated IP address to an existing dedicated IP pool
put_dedicated_ip_warmup_attributes Put dedicated ip warmup attributes
put_deliverability_dashboard_option Enable or disable the Deliverability dashboard for your Amazon Pinpoint account
put_email_identity_dkim_attributes Used to enable or disable DKIM authentication for an email identity
put_email_identity_feedback_attributes Used to enable or disable feedback forwarding for an identity
put_email_identity_mail_from_attributes Used to enable or disable the custom Mail-From domain configuration for an email identity
send_email Sends an email message
tag_resource Add one or more tags (keys and values) to a specified resource
untag_resource Remove one or more tags (keys and values) from a specified resource
update_configuration_set_event_destination Update the configuration of an event destination for a configuration set

Examples

## Not run: 
svc <- pinpointemail()
svc$create_configuration_set(
  Foo = 123
)

## End(Not run)

Amazon Pinpoint SMS and Voice Service

Description

Pinpoint SMS and Voice Messaging public facing APIs

Usage

pinpointsmsvoice(
  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 <- pinpointsmsvoice(
  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_configuration_set Create a new configuration set
create_configuration_set_event_destination Create a new event destination in a configuration set
delete_configuration_set Deletes an existing configuration set
delete_configuration_set_event_destination Deletes an event destination in a configuration set
get_configuration_set_event_destinations Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination
list_configuration_sets List all of the configuration sets associated with your Amazon Pinpoint account in the current region
send_voice_message Create a new voice message and send it to a recipient's phone number
update_configuration_set_event_destination Update an event destination in a configuration set

Examples

## Not run: 
svc <- pinpointsmsvoice()
svc$create_configuration_set(
  Foo = 123
)

## End(Not run)

Amazon Pinpoint SMS Voice V2

Description

Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The AWS End User Messaging SMS and Voice version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

Usage

pinpointsmsvoicev2(
  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 <- pinpointsmsvoicev2(
  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

associate_origination_identity Associates the specified origination identity with a pool
associate_protect_configuration Associate a protect configuration with a configuration set
create_configuration_set Creates a new configuration set
create_event_destination Creates a new event destination in a configuration set
create_opt_out_list Creates a new opt-out list
create_pool Creates a new pool and associates the specified origination identity to the pool
create_protect_configuration Create a new protect configuration
create_registration Creates a new registration based on the RegistrationType field
create_registration_association Associate the registration with an origination identity such as a phone number or sender ID
create_registration_attachment Create a new registration attachment to use for uploading a file or a URL to a file
create_registration_version Create a new version of the registration and increase the VersionNumber
create_verified_destination_number You can only send messages to verified destination numbers when your account is in the sandbox
delete_account_default_protect_configuration Removes the current account default protect configuration
delete_configuration_set Deletes an existing configuration set
delete_default_message_type Deletes an existing default message type on a configuration set
delete_default_sender_id Deletes an existing default sender ID on a configuration set
delete_event_destination Deletes an existing event destination
delete_keyword Deletes an existing keyword from an origination phone number or pool
delete_media_message_spend_limit_override Deletes an account-level monthly spending limit override for sending multimedia messages (MMS)
delete_opted_out_number Deletes an existing opted out destination phone number from the specified opt-out list
delete_opt_out_list Deletes an existing opt-out list
delete_pool Deletes an existing pool
delete_protect_configuration Permanently delete the protect configuration
delete_registration Permanently delete an existing registration from your account
delete_registration_attachment Permanently delete the specified registration attachment
delete_registration_field_value Delete the value in a registration form field
delete_text_message_spend_limit_override Deletes an account-level monthly spending limit override for sending text messages
delete_verified_destination_number Delete a verified destination phone number
delete_voice_message_spend_limit_override Deletes an account level monthly spend limit override for sending voice messages
describe_account_attributes Describes attributes of your Amazon Web Services account
describe_account_limits Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account
describe_configuration_sets Describes the specified configuration sets or all in your account
describe_keywords Describes the specified keywords or all keywords on your origination phone number or pool
describe_opted_out_numbers Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list
describe_opt_out_lists Describes the specified opt-out list or all opt-out lists in your account
describe_phone_numbers Describes the specified origination phone number, or all the phone numbers in your account
describe_pools Retrieves the specified pools or all pools associated with your Amazon Web Services account
describe_protect_configurations Retrieves the protect configurations that match any of filters
describe_registration_attachments Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account
describe_registration_field_definitions Retrieves the specified registration type field definitions
describe_registration_field_values Retrieves the specified registration field values
describe_registrations Retrieves the specified registrations
describe_registration_section_definitions Retrieves the specified registration section definitions
describe_registration_type_definitions Retrieves the specified registration type definitions
describe_registration_versions Retrieves the specified registration version
describe_sender_ids Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account
describe_spend_limits Describes the current monthly spend limits for sending voice and text messages
describe_verified_destination_numbers Retrieves the specified verified destiona numbers
disassociate_origination_identity Removes the specified origination identity from an existing pool
disassociate_protect_configuration Disassociate a protect configuration from a configuration set
discard_registration_version Discard the current version of the registration
get_protect_configuration_country_rule_set Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration
list_pool_origination_identities Lists all associated origination identities in your pool
list_registration_associations Retreive all of the origination identies that are associated with a registration
list_tags_for_resource List all tags associated with a resource
put_keyword Creates or updates a keyword configuration on an origination phone number or pool
put_opted_out_number Creates an opted out destination phone number in the opt-out list
put_registration_field_value Creates or updates a field value for a registration
release_phone_number Releases an existing origination phone number in your account
release_sender_id Releases an existing sender ID in your account
request_phone_number Request an origination phone number for use in your account
request_sender_id Request a new sender ID that doesn't require registration
send_destination_number_verification_code Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number
send_media_message Creates a new multimedia message (MMS) and sends it to a recipient's phone number
send_text_message Creates a new text message and sends it to a recipient's phone number
send_voice_message Allows you to send a request that sends a voice message
set_account_default_protect_configuration Set a protect configuration as your account default
set_default_message_type Sets the default message type on a configuration set
set_default_sender_id Sets default sender ID on a configuration set
set_media_message_spend_limit_override Sets an account level monthly spend limit override for sending MMS messages
set_text_message_spend_limit_override Sets an account level monthly spend limit override for sending text messages
set_voice_message_spend_limit_override Sets an account level monthly spend limit override for sending voice messages
submit_registration_version Submit the specified registration for review and approval
tag_resource Adds or overwrites only the specified tags for the specified resource
untag_resource Removes the association of the specified tags from a resource
update_event_destination Updates an existing event destination in a configuration set
update_phone_number Updates the configuration of an existing origination phone number
update_pool Updates the configuration of an existing pool
update_protect_configuration Update the setting for an existing protect configuration
update_protect_configuration_country_rule_set Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties
update_sender_id Updates the configuration of an existing sender ID
verify_destination_number Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages

Examples

## Not run: 
svc <- pinpointsmsvoicev2()
svc$associate_origination_identity(
  Foo = 123
)

## End(Not run)

Amazon Simple Email Service

Description

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

This documentation contains reference information related to the following:

Usage

ses(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 <- ses(
  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

clone_receipt_rule_set Creates a receipt rule set by cloning an existing one
create_configuration_set Creates a configuration set
create_configuration_set_event_destination Creates a configuration set event destination
create_configuration_set_tracking_options Creates an association between a configuration set and a custom domain for open and click event tracking
create_custom_verification_email_template Creates a new custom verification email template
create_receipt_filter Creates a new IP address filter
create_receipt_rule Creates a receipt rule
create_receipt_rule_set Creates an empty receipt rule set
create_template Creates an email template
delete_configuration_set Deletes a configuration set
delete_configuration_set_event_destination Deletes a configuration set event destination
delete_configuration_set_tracking_options Deletes an association between a configuration set and a custom domain for open and click event tracking
delete_custom_verification_email_template Deletes an existing custom verification email template
delete_identity Deletes the specified identity (an email address or a domain) from the list of verified identities
delete_identity_policy Deletes the specified sending authorization policy for the given identity (an email address or a domain)
delete_receipt_filter Deletes the specified IP address filter
delete_receipt_rule Deletes the specified receipt rule
delete_receipt_rule_set Deletes the specified receipt rule set and all of the receipt rules it contains
delete_template Deletes an email template
delete_verified_email_address Deprecated
describe_active_receipt_rule_set Returns the metadata and receipt rules for the receipt rule set that is currently active
describe_configuration_set Returns the details of the specified configuration set
describe_receipt_rule Returns the details of the specified receipt rule
describe_receipt_rule_set Returns the details of the specified receipt rule set
get_account_sending_enabled Returns the email sending status of the Amazon SES account for the current Region
get_custom_verification_email_template Returns the custom email verification template for the template name you specify
get_identity_dkim_attributes Returns the current status of Easy DKIM signing for an entity
get_identity_mail_from_domain_attributes Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains)
get_identity_notification_attributes Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes
get_identity_policies Returns the requested sending authorization policies for the given identity (an email address or a domain)
get_identity_verification_attributes Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity
get_send_quota Provides the sending limits for the Amazon SES account
get_send_statistics Provides sending statistics for the current Amazon Web Services Region
get_template Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify
list_configuration_sets Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region
list_custom_verification_email_templates Lists the existing custom verification email templates for your account in the current Amazon Web Services Region
list_identities Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status
list_identity_policies Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain)
list_receipt_filters Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region
list_receipt_rule_sets Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region
list_templates Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region
list_verified_email_addresses Deprecated
put_configuration_set_delivery_options Adds or updates the delivery options for a configuration set
put_identity_policy Adds or updates a sending authorization policy for the specified identity (an email address or a domain)
reorder_receipt_rule_set Reorders the receipt rules within a receipt rule set
send_bounce Generates and sends a bounce message to the sender of an email you received through Amazon SES
send_bulk_templated_email Composes an email message to multiple destinations
send_custom_verification_email Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it
send_email Composes an email message and immediately queues it for sending
send_raw_email Composes an email message and immediately queues it for sending
send_templated_email Composes an email message using an email template and immediately queues it for sending
set_active_receipt_rule_set Sets the specified receipt rule set as the active receipt rule set
set_identity_dkim_enabled Enables or disables Easy DKIM signing of email sent from an identity
set_identity_feedback_forwarding_enabled Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email
set_identity_headers_in_notifications_enabled Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type
set_identity_mail_from_domain Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain)
set_identity_notification_topic Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications
set_receipt_rule_position Sets the position of the specified receipt rule in the receipt rule set
test_render_template Creates a preview of the MIME content of an email when provided with a template and a set of replacement data
update_account_sending_enabled Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region
update_configuration_set_event_destination Updates the event destination of a configuration set
update_configuration_set_reputation_metrics_enabled Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region
update_configuration_set_sending_enabled Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region
update_configuration_set_tracking_options Modifies an association between a configuration set and a custom domain for open and click event tracking
update_custom_verification_email_template Updates an existing custom verification email template
update_receipt_rule Updates a receipt rule
update_template Updates an email template
verify_domain_dkim Returns a set of DKIM tokens for a domain identity
verify_domain_identity Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it
verify_email_address Deprecated
verify_email_identity Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it

Examples

## Not run: 
svc <- ses()
# The following example creates a receipt rule set by cloning an existing
# one:
svc$clone_receipt_rule_set(
  OriginalRuleSetName = "RuleSetToClone",
  RuleSetName = "RuleSetToCreate"
)

## End(Not run)

Amazon Simple Email Service

Description

Amazon SES API v2

Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.

If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

Usage

sesv2(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 <- sesv2(
  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

batch_get_metric_data Retrieves batches of metric data collected based on your sending activity
cancel_export_job Cancels an export job
create_configuration_set Create a configuration set
create_configuration_set_event_destination Create an event destination
create_contact Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list
create_contact_list Creates a contact list
create_custom_verification_email_template Creates a new custom verification email template
create_dedicated_ip_pool Create a new pool of dedicated IP addresses
create_deliverability_test_report Create a new predictive inbox placement test
create_email_identity Starts the process of verifying an email identity
create_email_identity_policy Creates the specified sending authorization policy for the given identity (an email address or a domain)
create_email_template Creates an email template
create_export_job Creates an export job for a data source and destination
create_import_job Creates an import job for a data destination
delete_configuration_set Delete an existing configuration set
delete_configuration_set_event_destination Delete an event destination
delete_contact Removes a contact from a contact list
delete_contact_list Deletes a contact list and all of the contacts on that list
delete_custom_verification_email_template Deletes an existing custom verification email template
delete_dedicated_ip_pool Delete a dedicated IP pool
delete_email_identity Deletes an email identity
delete_email_identity_policy Deletes the specified sending authorization policy for the given identity (an email address or a domain)
delete_email_template Deletes an email template
delete_suppressed_destination Removes an email address from the suppression list for your account
get_account Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region
get_blacklist_reports Retrieve a list of the blacklists that your dedicated IP addresses appear on
get_configuration_set Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more
get_configuration_set_event_destinations Retrieve a list of event destinations that are associated with a configuration set
get_contact Returns a contact from a contact list
get_contact_list Returns contact list metadata
get_custom_verification_email_template Returns the custom email verification template for the template name you specify
get_dedicated_ip Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address
get_dedicated_ip_pool Retrieve information about the dedicated pool
get_dedicated_ips List the dedicated IP addresses that are associated with your Amazon Web Services account
get_deliverability_dashboard_options Retrieve information about the status of the Deliverability dashboard for your account
get_deliverability_test_report Retrieve the results of a predictive inbox placement test
get_domain_deliverability_campaign Retrieve all the deliverability data for a specific campaign
get_domain_statistics_report Retrieve inbox placement and engagement rates for the domains that you use to send email
get_email_identity Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings
get_email_identity_policies Returns the requested sending authorization policies for the given identity (an email address or a domain)
get_email_template Displays the template object (which includes the subject line, HTML part and text part) for the template you specify
get_export_job Provides information about an export job
get_import_job Provides information about an import job
get_message_insights Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message
get_suppressed_destination Retrieves information about a specific email address that's on the suppression list for your account
list_configuration_sets List all of the configuration sets associated with your account in the current region
list_contact_lists Lists all of the contact lists available
list_contacts Lists the contacts present in a specific contact list
list_custom_verification_email_templates Lists the existing custom verification email templates for your account in the current Amazon Web Services Region
list_dedicated_ip_pools List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region
list_deliverability_test_reports Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses
list_domain_deliverability_campaigns Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range
list_email_identities Returns a list of all of the email identities that are associated with your Amazon Web Services account
list_email_templates Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region
list_export_jobs Lists all of the export jobs
list_import_jobs Lists all of the import jobs
list_recommendations Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region
list_suppressed_destinations Retrieves a list of email addresses that are on the suppression list for your account
list_tags_for_resource Retrieve a list of the tags (keys and values) that are associated with a specified resource
put_account_dedicated_ip_warmup_attributes Enable or disable the automatic warm-up feature for dedicated IP addresses
put_account_details Update your Amazon SES account details
put_account_sending_attributes Enable or disable the ability of your account to send email
put_account_suppression_attributes Change the settings for the account-level suppression list
put_account_vdm_attributes Update your Amazon SES account VDM attributes
put_configuration_set_delivery_options Associate a configuration set with a dedicated IP pool
put_configuration_set_reputation_options Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region
put_configuration_set_sending_options Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region
put_configuration_set_suppression_options Specify the account suppression list preferences for a configuration set
put_configuration_set_tracking_options Specify a custom domain to use for open and click tracking elements in email that you send
put_configuration_set_vdm_options Specify VDM preferences for email that you send using the configuration set
put_dedicated_ip_in_pool Move a dedicated IP address to an existing dedicated IP pool
put_dedicated_ip_pool_scaling_attributes Used to convert a dedicated IP pool to a different scaling mode
put_dedicated_ip_warmup_attributes Put dedicated ip warmup attributes
put_deliverability_dashboard_option Enable or disable the Deliverability dashboard
put_email_identity_configuration_set_attributes Used to associate a configuration set with an email identity
put_email_identity_dkim_attributes Used to enable or disable DKIM authentication for an email identity
put_email_identity_dkim_signing_attributes Used to configure or change the DKIM authentication settings for an email domain identity
put_email_identity_feedback_attributes Used to enable or disable feedback forwarding for an identity
put_email_identity_mail_from_attributes Used to enable or disable the custom Mail-From domain configuration for an email identity
put_suppressed_destination Adds an email address to the suppression list for your account
send_bulk_email Composes an email message to multiple destinations
send_custom_verification_email Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it
send_email Sends an email message
tag_resource Add one or more tags (keys and values) to a specified resource
test_render_email_template Creates a preview of the MIME content of an email when provided with a template and a set of replacement data
untag_resource Remove one or more tags (keys and values) from a specified resource
update_configuration_set_event_destination Update the configuration of an event destination for a configuration set
update_contact Updates a contact's preferences for a list
update_contact_list Updates contact list metadata
update_custom_verification_email_template Updates an existing custom verification email template
update_email_identity_policy Updates the specified sending authorization policy for the given identity (an email address or a domain)
update_email_template Updates an email template

Examples

## Not run: 
svc <- sesv2()
# Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
svc$cancel_export_job(
  JobId = "ef28cf62-9d8e-4b60-9283-b09816c99a99"
)

## End(Not run)