Package 'paws.business.applications'

Title: 'Amazon Web Services' Business Applications Services
Description: Interface to 'Amazon Web Services' business applications services, including online meetings and video conferencing, email and calendar 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-10-06 06:21:32 UTC
Source: https://github.com/paws-r/paws

Help Index


Alexa For Business

Description

Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.

Usage

alexaforbusiness(config = list())

Arguments

config

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

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 <- alexaforbusiness(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

approve_skill Associates a skill with the organization under the customer's AWS account
associate_contact_with_address_book Associates a contact with a given address book
associate_device_with_network_profile Associates a device with the specified network profile
associate_device_with_room Associates a device with a given room
associate_skill_group_with_room Associates a skill group with a given room
associate_skill_with_skill_group Associates a skill with a skill group
associate_skill_with_users Makes a private skill available for enrolled users to enable on their devices
create_address_book Creates an address book with the specified details
create_business_report_schedule Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval
create_conference_provider Adds a new conference provider under the user's AWS account
create_contact Creates a contact with the specified details
create_gateway_group Creates a gateway group with the specified details
create_network_profile Creates a network profile with the specified details
create_profile Creates a new room profile with the specified details
create_room Creates a room with the specified details
create_skill_group Creates a skill group with a specified name and description
create_user Creates a user
delete_address_book Deletes an address book by the address book ARN
delete_business_report_schedule Deletes the recurring report delivery schedule with the specified schedule ARN
delete_conference_provider Deletes a conference provider
delete_contact Deletes a contact by the contact ARN
delete_device Removes a device from Alexa For Business
delete_device_usage_data When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data
delete_gateway_group Deletes a gateway group
delete_network_profile Deletes a network profile by the network profile ARN
delete_profile Deletes a room profile by the profile ARN
delete_room Deletes a room by the room ARN
delete_room_skill_parameter Deletes room skill parameter details by room, skill, and parameter key ID
delete_skill_authorization Unlinks a third-party account from a skill
delete_skill_group Deletes a skill group by skill group ARN
delete_user Deletes a specified user by user ARN and enrollment ARN
disassociate_contact_from_address_book Disassociates a contact from a given address book
disassociate_device_from_room Disassociates a device from its current room
disassociate_skill_from_skill_group Disassociates a skill from a skill group
disassociate_skill_from_users Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices
disassociate_skill_group_from_room Disassociates a skill group from a specified room
forget_smart_home_appliances Forgets smart home appliances associated to a room
get_address_book Gets address the book details by the address book ARN
get_conference_preference Retrieves the existing conference preferences
get_conference_provider Gets details about a specific conference provider
get_contact Gets the contact details by the contact ARN
get_device Gets the details of a device by device ARN
get_gateway Retrieves the details of a gateway
get_gateway_group Retrieves the details of a gateway group
get_invitation_configuration Retrieves the configured values for the user enrollment invitation email template
get_network_profile Gets the network profile details by the network profile ARN
get_profile Gets the details of a room profile by profile ARN
get_room Gets room details by room ARN
get_room_skill_parameter Gets room skill parameter details by room, skill, and parameter key ARN
get_skill_group Gets skill group details by skill group ARN
list_business_report_schedules Lists the details of the schedules that a user configured
list_conference_providers Lists conference providers under a specific AWS account
list_device_events Lists the device event history, including device connection status, for up to 30 days
list_gateway_groups Retrieves a list of gateway group summaries
list_gateways Retrieves a list of gateway summaries
list_skills Lists all enabled skills in a specific skill group
list_skills_store_categories Lists all categories in the Alexa skill store
list_skills_store_skills_by_category Lists all skills in the Alexa skill store by category
list_smart_home_appliances Lists all of the smart home appliances associated with a room
list_tags Lists all tags for the specified resource
put_conference_preference Sets the conference preferences on a specific conference provider at the account level
put_invitation_configuration Configures the email template for the user enrollment invitation with the specified attributes
put_room_skill_parameter Updates room skill parameter details by room, skill, and parameter key ID
put_skill_authorization Links a user's account to a third-party skill provider
register_avs_device Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS)
reject_skill Disassociates a skill from the organization under a user's AWS account
resolve_room Determines the details for the room from which a skill request was invoked
revoke_invitation Revokes an invitation and invalidates the enrollment URL
search_address_books Searches address books and lists the ones that meet a set of filter and sort criteria
search_contacts Searches contacts and lists the ones that meet a set of filter and sort criteria
search_devices Searches devices and lists the ones that meet a set of filter criteria
search_network_profiles Searches network profiles and lists the ones that meet a set of filter and sort criteria
search_profiles Searches room profiles and lists the ones that meet a set of filter criteria
search_rooms Searches rooms and lists the ones that meet a set of filter and sort criteria
search_skill_groups Searches skill groups and lists the ones that meet a set of filter and sort criteria
search_users Searches users and lists the ones that meet a set of filter and sort criteria
send_announcement Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter
send_invitation Sends an enrollment invitation email with a URL to a user
start_device_sync Resets a device and its account to the known default settings
start_smart_home_appliance_discovery Initiates the discovery of any smart home appliances associated with the room
tag_resource Adds metadata tags to a specified resource
untag_resource Removes metadata tags from a specified resource
update_address_book Updates address book details by the address book ARN
update_business_report_schedule Updates the configuration of the report delivery schedule with the specified schedule ARN
update_conference_provider Updates an existing conference provider's settings
update_contact Updates the contact details by the contact ARN
update_device Updates the device name by device ARN
update_gateway Updates the details of a gateway
update_gateway_group Updates the details of a gateway group
update_network_profile Updates a network profile by the network profile ARN
update_profile Updates an existing room profile by room profile ARN
update_room Updates room details by room ARN
update_skill_group Updates skill group details by skill group ARN

Examples

## Not run: 
svc <- alexaforbusiness()
svc$approve_skill(
  Foo = 123
)

## End(Not run)

Amazon Chime

Description

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint ⁠https://service.chime.aws.amazon.com⁠.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Usage

chime(config = list())

Arguments

config

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

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 <- chime(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_phone_numbers_with_voice_connector Associates phone numbers with the specified Amazon Chime Voice Connector
associate_phone_numbers_with_voice_connector_group Associates phone numbers with the specified Amazon Chime Voice Connector group
associate_phone_number_with_user Associates a phone number with the specified Amazon Chime user
associate_signin_delegate_groups_with_account Associates the specified sign-in delegate groups with the specified Amazon Chime account
batch_create_attendee Creates up to 100 new attendees for an active Amazon Chime SDK meeting
batch_create_room_membership Adds up to 50 members to a chat room in an Amazon Chime Enterprise account
batch_delete_phone_number Moves phone numbers into the Deletion queue
batch_suspend_user Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account
batch_unsuspend_user Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account
batch_update_phone_number Updates phone number product types or calling names
batch_update_user Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account
create_account Creates an Amazon Chime account under the administrator's AWS account
create_app_instance Creates an Amazon Chime Messaging SDK AppInstance under an AWS Account
create_app_instance_admin Promotes an AppInstanceUser to an AppInstanceAdmin
create_app_instance_user Creates a user under an Amazon Chime AppInstance
create_attendee Creates a new attendee for an active Amazon Chime SDK meeting
create_bot Creates a bot for an Amazon Chime Enterprise account
create_channel Creates a channel to which you can add users and send messages
create_channel_ban Permanently bans a member from a channel
create_channel_membership Adds a user to a channel
create_channel_moderator Creates a new ChannelModerator
create_meeting Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees
create_meeting_dial_out Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and joins them into Chime meeting
create_meeting_with_attendees Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees
create_phone_number_order Creates an order for phone numbers to be provisioned
create_proxy_session Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers
create_room Creates a chat room for the specified Amazon Chime Enterprise account
create_room_membership Adds a member to a chat room in an Amazon Chime Enterprise account
create_sip_media_application Creates a SIP media application
create_sip_media_application_call Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId
create_sip_rule Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type
create_user Creates a user under the specified Amazon Chime account
create_voice_connector Creates an Amazon Chime Voice Connector under the administrator's AWS account
create_voice_connector_group Creates an Amazon Chime Voice Connector group under the administrator's AWS account
delete_account Deletes the specified Amazon Chime account
delete_app_instance Deletes an AppInstance and all associated data asynchronously
delete_app_instance_admin Demotes an AppInstanceAdmin to an AppInstanceUser
delete_app_instance_streaming_configurations Deletes the streaming configurations of an app instance
delete_app_instance_user Deletes an AppInstanceUser
delete_attendee Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
delete_channel Immediately makes a channel and its memberships inaccessible and marks them for deletion
delete_channel_ban Removes a user from a channel's ban list
delete_channel_membership Removes a member from a channel
delete_channel_message Deletes a channel message
delete_channel_moderator Deletes a channel moderator
delete_events_configuration Deletes the events configuration that allows a bot to receive outgoing events
delete_meeting Deletes the specified Amazon Chime SDK meeting
delete_phone_number Moves the specified phone number into the Deletion queue
delete_proxy_session Deletes the specified proxy session from the specified Amazon Chime Voice Connector
delete_room Deletes a chat room in an Amazon Chime Enterprise account
delete_room_membership Removes a member from a chat room in an Amazon Chime Enterprise account
delete_sip_media_application Deletes a SIP media application
delete_sip_rule Deletes a SIP rule
delete_voice_connector Deletes the specified Amazon Chime Voice Connector
delete_voice_connector_emergency_calling_configuration Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector
delete_voice_connector_group Deletes the specified Amazon Chime Voice Connector group
delete_voice_connector_origination Deletes the origination settings for the specified Amazon Chime Voice Connector
delete_voice_connector_proxy Deletes the proxy configuration from the specified Amazon Chime Voice Connector
delete_voice_connector_streaming_configuration Deletes the streaming configuration for the specified Amazon Chime Voice Connector
delete_voice_connector_termination Deletes the termination settings for the specified Amazon Chime Voice Connector
delete_voice_connector_termination_credentials Deletes the specified SIP credentials used by your equipment to authenticate during call termination
describe_app_instance Returns the full details of an AppInstance
describe_app_instance_admin Returns the full details of an AppInstanceAdmin
describe_app_instance_user Returns the full details of an AppInstanceUser
describe_channel Returns the full details of a channel in an Amazon Chime app instance
describe_channel_ban Returns the full details of a channel ban
describe_channel_membership Returns the full details of a user's channel membership
describe_channel_membership_for_app_instance_user Returns the details of a channel based on the membership of the AppInstanceUser specified
describe_channel_moderated_by_app_instance_user Returns the full details of a channel moderated by the specified AppInstanceUser
describe_channel_moderator Returns the full details of a single ChannelModerator
disassociate_phone_number_from_user Disassociates the primary provisioned phone number from the specified Amazon Chime user
disassociate_phone_numbers_from_voice_connector Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector
disassociate_phone_numbers_from_voice_connector_group Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group
disassociate_signin_delegate_groups_from_account Disassociates the specified sign-in delegate groups from the specified Amazon Chime account
get_account Retrieves details for the specified Amazon Chime account, such as account type and supported licenses
get_account_settings Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings
get_app_instance_retention_settings Gets the retention settings for an app instance
get_app_instance_streaming_configurations Gets the streaming settings for an app instance
get_attendee Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID
get_bot Retrieves details for the specified bot, such as bot email address, bot type, status, and display name
get_channel_message Gets the full details of a channel message
get_events_configuration Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN
get_global_settings Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings
get_meeting Gets the Amazon Chime SDK meeting details for the specified meeting ID
get_messaging_session_endpoint The endpoint for the messaging session
get_phone_number Retrieves details for the specified phone number ID, such as associations, capabilities, and product type
get_phone_number_order Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E
get_phone_number_settings Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name
get_proxy_session Gets the specified proxy session details for the specified Amazon Chime Voice Connector
get_retention_settings Gets the retention settings for the specified Amazon Chime Enterprise account
get_room Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account
get_sip_media_application Retrieves the information for a SIP media application, including name, AWS Region, and endpoints
get_sip_media_application_logging_configuration Returns the logging configuration for the specified SIP media application
get_sip_rule Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints
get_user Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN
get_user_settings Retrieves settings for the specified user ID, such as any associated phone number settings
get_voice_connector Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements
get_voice_connector_emergency_calling_configuration Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector
get_voice_connector_group Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems
get_voice_connector_logging_configuration Retrieves the logging configuration details for the specified Amazon Chime Voice Connector
get_voice_connector_origination Retrieves origination setting details for the specified Amazon Chime Voice Connector
get_voice_connector_proxy Gets the proxy configuration details for the specified Amazon Chime Voice Connector
get_voice_connector_streaming_configuration Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector
get_voice_connector_termination Retrieves termination setting details for the specified Amazon Chime Voice Connector
get_voice_connector_termination_health Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector
invite_users Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account
list_accounts Lists the Amazon Chime accounts under the administrator's AWS account
list_app_instance_admins Returns a list of the administrators in the app instance
list_app_instances Lists all Amazon Chime app instances created under a single AWS account
list_app_instance_users List all AppInstanceUsers created under a single app instance
list_attendees Lists the attendees for the specified Amazon Chime SDK meeting
list_attendee_tags Lists the tags applied to an Amazon Chime SDK attendee resource
list_bots Lists the bots associated with the administrator's Amazon Chime Enterprise account ID
list_channel_bans Lists all the users banned from a particular channel
list_channel_memberships Lists all channel memberships in a channel
list_channel_memberships_for_app_instance_user Lists all channels that a particular AppInstanceUser is a part of
list_channel_messages List all the messages in a channel
list_channel_moderators Lists all the moderators for a channel
list_channels Lists all Channels created under a single Chime App as a paginated list
list_channels_moderated_by_app_instance_user A list of the channels moderated by an app instance user
list_meetings Lists up to 100 active Amazon Chime SDK meetings
list_meeting_tags Lists the tags applied to an Amazon Chime SDK meeting resource
list_phone_number_orders Lists the phone number orders for the administrator's Amazon Chime account
list_phone_numbers Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group
list_proxy_sessions Lists the proxy sessions for the specified Amazon Chime Voice Connector
list_room_memberships Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names
list_rooms Lists the room details for the specified Amazon Chime Enterprise account
list_sip_media_applications Lists the SIP media applications under the administrator's AWS account
list_sip_rules Lists the SIP rules under the administrator's AWS account
list_tags_for_resource Lists the tags applied to an Amazon Chime SDK meeting resource
list_users Lists the users that belong to the specified Amazon Chime account
list_voice_connector_groups Lists the Amazon Chime Voice Connector groups for the administrator's AWS account
list_voice_connectors Lists the Amazon Chime Voice Connectors for the administrator's AWS account
list_voice_connector_termination_credentials Lists the SIP credentials for the specified Amazon Chime Voice Connector
logout_user Logs out the specified user from all of the devices they are currently logged into
put_app_instance_retention_settings Sets the amount of time in days that a given app instance retains data
put_app_instance_streaming_configurations The data streaming configurations of an app instance
put_events_configuration Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime
put_retention_settings Puts retention settings for the specified Amazon Chime Enterprise account
put_sip_media_application_logging_configuration Updates the logging configuration for the specified SIP media application
put_voice_connector_emergency_calling_configuration Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries
put_voice_connector_logging_configuration Adds a logging configuration for the specified Amazon Chime Voice Connector
put_voice_connector_origination Adds origination settings for the specified Amazon Chime Voice Connector
put_voice_connector_proxy Puts the specified proxy configuration to the specified Amazon Chime Voice Connector
put_voice_connector_streaming_configuration Adds a streaming configuration for the specified Amazon Chime Voice Connector
put_voice_connector_termination Adds termination settings for the specified Amazon Chime Voice Connector
put_voice_connector_termination_credentials Adds termination SIP credentials for the specified Amazon Chime Voice Connector
redact_channel_message Redacts message content, but not metadata
redact_conversation_message Redacts the specified message from the specified Amazon Chime conversation
redact_room_message Redacts the specified message from the specified Amazon Chime channel
regenerate_security_token Regenerates the security token for a bot
reset_personal_pin Resets the personal meeting PIN for the specified user on an Amazon Chime account
restore_phone_number Moves a phone number from the Deletion queue back into the phone number Inventory
search_available_phone_numbers Searches phone numbers that can be ordered
send_channel_message Sends a message to a particular channel that the member is a part of
tag_attendee Applies the specified tags to the specified Amazon Chime SDK attendee
tag_meeting Applies the specified tags to the specified Amazon Chime SDK meeting
tag_resource Applies the specified tags to the specified Amazon Chime SDK meeting resource
untag_attendee Untags the specified tags from the specified Amazon Chime SDK attendee
untag_meeting Untags the specified tags from the specified Amazon Chime SDK meeting
untag_resource Untags the specified tags from the specified Amazon Chime SDK meeting resource
update_account Updates account details for the specified Amazon Chime account
update_account_settings Updates the settings for the specified Amazon Chime account
update_app_instance Updates AppInstance metadata
update_app_instance_user Updates the details for an AppInstanceUser
update_bot Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account
update_channel Update a channel's attributes
update_channel_message Updates the content of a message
update_channel_read_marker Sets the timestamp to the point when a user last read messages in a channel
update_global_settings Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings
update_phone_number Updates phone number details, such as product type or calling name, for the specified phone number ID
update_phone_number_settings Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name
update_proxy_session Updates the specified proxy session details, such as voice or SMS capabilities
update_room Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account
update_room_membership Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account
update_sip_media_application Updates the details for the specified SIP media application
update_sip_rule Updates the details for the specified SIP rule
update_user Updates user details for a specified user ID
update_user_settings Updates the settings for the specified user, such as phone number settings
update_voice_connector Updates details for the specified Amazon Chime Voice Connector
update_voice_connector_group Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking

Examples

## Not run: 
svc <- chime()
svc$associate_phone_number_with_user(
  Foo = 123
)

## End(Not run)

Amazon WorkMail

Description

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

Usage

workmail(config = list())

Arguments

config

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

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 <- workmail(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_delegate_to_resource Adds a member (user or group) to the resource's set of delegates
associate_member_to_group Adds a member (user or group) to the group's set
cancel_mailbox_export_job Cancels a mailbox export job
create_alias Adds an alias to the set of a given member (user or group) of Amazon WorkMail
create_group Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation
create_organization Creates a new Amazon WorkMail organization
create_resource Creates a new Amazon WorkMail resource
create_user Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation
delete_access_control_rule Deletes an access control rule for the specified WorkMail organization
delete_alias Remove one or more specified aliases from a set of aliases for a given user
delete_group Deletes a group from Amazon WorkMail
delete_mailbox_permissions Deletes permissions granted to a member (user or group)
delete_organization Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization
delete_resource Deletes the specified resource
delete_retention_policy Deletes the specified retention policy from the specified organization
delete_user Deletes a user from Amazon WorkMail and all subsequent systems
deregister_from_work_mail Mark a user, group, or resource as no longer used in Amazon WorkMail
describe_group Returns the data available for the group
describe_mailbox_export_job Describes the current status of a mailbox export job
describe_organization Provides more information regarding a given organization based on its identifier
describe_resource Returns the data available for the resource
describe_user Provides information regarding the user
disassociate_delegate_from_resource Removes a member from the resource's set of delegates
disassociate_member_from_group Removes a member from a group
get_access_control_effect Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID
get_default_retention_policy Gets the default retention policy details for the specified organization
get_mailbox_details Requests a user's mailbox details for a specified organization and user
list_access_control_rules Lists the access control rules for the specified organization
list_aliases Creates a paginated call to list the aliases associated with a given entity
list_group_members Returns an overview of the members of a group
list_groups Returns summaries of the organization's groups
list_mailbox_export_jobs Lists the mailbox export jobs started for the specified organization within the last seven days
list_mailbox_permissions Lists the mailbox permissions associated with a user, group, or resource mailbox
list_organizations Returns summaries of the customer's organizations
list_resource_delegates Lists the delegates associated with a resource
list_resources Returns summaries of the organization's resources
list_tags_for_resource Lists the tags applied to an Amazon WorkMail organization resource
list_users Returns summaries of the organization's users
put_access_control_rule Adds a new access control rule for the specified organization
put_mailbox_permissions Sets permissions for a user, group, or resource
put_retention_policy Puts a retention policy to the specified organization
register_to_work_mail Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities
reset_password Allows the administrator to reset the password for a user
start_mailbox_export_job Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket
tag_resource Applies the specified tags to the specified Amazon WorkMail organization resource
untag_resource Untags the specified tags from the specified Amazon WorkMail organization resource
update_mailbox_quota Updates a user's current mailbox quota for a specified organization and user
update_primary_email_address Updates the primary email for a user, group, or resource
update_resource Updates data for the resource

Examples

## Not run: 
svc <- workmail()
svc$associate_delegate_to_resource(
  Foo = 123
)

## End(Not run)