Class: Aws::WorkMail::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkMail::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb
Overview
An API client for WorkMail. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::WorkMail::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_delegate_to_resource(params = {}) ⇒ Struct
Adds a member (user or group) to the resource's set of delegates.
-
#associate_member_to_group(params = {}) ⇒ Struct
Adds a member (user or group) to the group's set.
-
#assume_impersonation_role(params = {}) ⇒ Types::AssumeImpersonationRoleResponse
Assumes an impersonation role for the given WorkMail organization.
-
#cancel_mailbox_export_job(params = {}) ⇒ Struct
Cancels a mailbox export job.
-
#create_alias(params = {}) ⇒ Struct
Adds an alias to the set of a given member (user or group) of WorkMail.
-
#create_availability_configuration(params = {}) ⇒ Struct
Creates an
AvailabilityConfiguration
for the given WorkMail organization and domain. -
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
-
#create_impersonation_role(params = {}) ⇒ Types::CreateImpersonationRoleResponse
Creates an impersonation role for the given WorkMail organization.
-
#create_mobile_device_access_rule(params = {}) ⇒ Types::CreateMobileDeviceAccessRuleResponse
Creates a new mobile device access rule for the specified WorkMail organization.
-
#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse
Creates a new WorkMail organization.
-
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
-
#delete_access_control_rule(params = {}) ⇒ Struct
Deletes an access control rule for the specified WorkMail organization.
-
#delete_alias(params = {}) ⇒ Struct
Remove one or more specified aliases from a set of aliases for a given user.
-
#delete_availability_configuration(params = {}) ⇒ Struct
Deletes the
AvailabilityConfiguration
for the given WorkMail organization and domain. -
#delete_email_monitoring_configuration(params = {}) ⇒ Struct
Deletes the email monitoring configuration for a specified organization.
-
#delete_group(params = {}) ⇒ Struct
Deletes a group from WorkMail.
-
#delete_impersonation_role(params = {}) ⇒ Struct
Deletes an impersonation role for the given WorkMail organization.
-
#delete_mailbox_permissions(params = {}) ⇒ Struct
Deletes permissions granted to a member (user or group).
-
#delete_mobile_device_access_override(params = {}) ⇒ Struct
Deletes the mobile device access override for the given WorkMail organization, user, and device.
-
#delete_mobile_device_access_rule(params = {}) ⇒ Struct
Deletes a mobile device access rule for the specified WorkMail organization.
-
#delete_organization(params = {}) ⇒ Types::DeleteOrganizationResponse
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.
-
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
-
#delete_retention_policy(params = {}) ⇒ Struct
Deletes the specified retention policy from the specified organization.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user from WorkMail and all subsequent systems.
-
#deregister_from_work_mail(params = {}) ⇒ Struct
Mark a user, group, or resource as no longer used in WorkMail.
-
#deregister_mail_domain(params = {}) ⇒ Struct
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.
-
#describe_email_monitoring_configuration(params = {}) ⇒ Types::DescribeEmailMonitoringConfigurationResponse
Describes the current email monitoring configuration for a specified organization.
-
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Returns basic details about an entity in WorkMail.
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns the data available for the group.
-
#describe_inbound_dmarc_settings(params = {}) ⇒ Types::DescribeInboundDmarcSettingsResponse
Lists the settings in a DMARC policy for a specified organization.
-
#describe_mailbox_export_job(params = {}) ⇒ Types::DescribeMailboxExportJobResponse
Describes the current status of a mailbox export job.
-
#describe_organization(params = {}) ⇒ Types::DescribeOrganizationResponse
Provides more information regarding a given organization based on its identifier.
-
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Returns the data available for the resource.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
-
#disassociate_delegate_from_resource(params = {}) ⇒ Struct
Removes a member from the resource's set of delegates.
-
#disassociate_member_from_group(params = {}) ⇒ Struct
Removes a member from a group.
-
#get_access_control_effect(params = {}) ⇒ Types::GetAccessControlEffectResponse
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID.
-
#get_default_retention_policy(params = {}) ⇒ Types::GetDefaultRetentionPolicyResponse
Gets the default retention policy details for the specified organization.
-
#get_impersonation_role(params = {}) ⇒ Types::GetImpersonationRoleResponse
Gets the impersonation role details for the given WorkMail organization.
-
#get_impersonation_role_effect(params = {}) ⇒ Types::GetImpersonationRoleEffectResponse
Tests whether the given impersonation role can impersonate a target user.
-
#get_mail_domain(params = {}) ⇒ Types::GetMailDomainResponse
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
-
#get_mailbox_details(params = {}) ⇒ Types::GetMailboxDetailsResponse
Requests a user's mailbox details for a specified organization and user.
-
#get_mobile_device_access_effect(params = {}) ⇒ Types::GetMobileDeviceAccessEffectResponse
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
-
#get_mobile_device_access_override(params = {}) ⇒ Types::GetMobileDeviceAccessOverrideResponse
Gets the mobile device access override for the given WorkMail organization, user, and device.
-
#list_access_control_rules(params = {}) ⇒ Types::ListAccessControlRulesResponse
Lists the access control rules for the specified organization.
-
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Creates a paginated call to list the aliases associated with a given entity.
-
#list_availability_configurations(params = {}) ⇒ Types::ListAvailabilityConfigurationsResponse
List all the
AvailabilityConfiguration
's for the given WorkMail organization. -
#list_group_members(params = {}) ⇒ Types::ListGroupMembersResponse
Returns an overview of the members of a group.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Returns summaries of the organization's groups.
-
#list_groups_for_entity(params = {}) ⇒ Types::ListGroupsForEntityResponse
Returns all the groups to which an entity belongs.
-
#list_impersonation_roles(params = {}) ⇒ Types::ListImpersonationRolesResponse
Lists all the impersonation roles for the given WorkMail organization.
-
#list_mail_domains(params = {}) ⇒ Types::ListMailDomainsResponse
Lists the mail domains in a given WorkMail organization.
-
#list_mailbox_export_jobs(params = {}) ⇒ Types::ListMailboxExportJobsResponse
Lists the mailbox export jobs started for the specified organization within the last seven days.
-
#list_mailbox_permissions(params = {}) ⇒ Types::ListMailboxPermissionsResponse
Lists the mailbox permissions associated with a user, group, or resource mailbox.
-
#list_mobile_device_access_overrides(params = {}) ⇒ Types::ListMobileDeviceAccessOverridesResponse
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
-
#list_mobile_device_access_rules(params = {}) ⇒ Types::ListMobileDeviceAccessRulesResponse
Lists the mobile device access rules for the specified WorkMail organization.
-
#list_organizations(params = {}) ⇒ Types::ListOrganizationsResponse
Returns summaries of the customer's organizations.
-
#list_resource_delegates(params = {}) ⇒ Types::ListResourceDelegatesResponse
Lists the delegates associated with a resource.
-
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Returns summaries of the organization's resources.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an WorkMail organization resource.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns summaries of the organization's users.
-
#put_access_control_rule(params = {}) ⇒ Struct
Adds a new access control rule for the specified organization.
-
#put_email_monitoring_configuration(params = {}) ⇒ Struct
Creates or updates the email monitoring configuration for a specified organization.
-
#put_inbound_dmarc_settings(params = {}) ⇒ Struct
Enables or disables a DMARC policy for a given organization.
-
#put_mailbox_permissions(params = {}) ⇒ Struct
Sets permissions for a user, group, or resource.
-
#put_mobile_device_access_override(params = {}) ⇒ Struct
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
-
#put_retention_policy(params = {}) ⇒ Struct
Puts a retention policy to the specified organization.
-
#register_mail_domain(params = {}) ⇒ Struct
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.
-
#register_to_work_mail(params = {}) ⇒ Struct
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.
-
#reset_password(params = {}) ⇒ Struct
Allows the administrator to reset the password for a user.
-
#start_mailbox_export_job(params = {}) ⇒ Types::StartMailboxExportJobResponse
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(params = {}) ⇒ Struct
Applies the specified tags to the specified WorkMailorganization resource.
-
#test_availability_configuration(params = {}) ⇒ Types::TestAvailabilityConfigurationResponse
Performs a test on an availability provider to ensure that access is allowed.
-
#untag_resource(params = {}) ⇒ Struct
Untags the specified tags from the specified WorkMail organization resource.
-
#update_availability_configuration(params = {}) ⇒ Struct
Updates an existing
AvailabilityConfiguration
for the given WorkMail organization and domain. -
#update_default_mail_domain(params = {}) ⇒ Struct
Updates the default mail domain for an organization.
-
#update_group(params = {}) ⇒ Struct
Updates attibutes in a group.
-
#update_impersonation_role(params = {}) ⇒ Struct
Updates an impersonation role for the given WorkMail organization.
-
#update_mailbox_quota(params = {}) ⇒ Struct
Updates a user's current mailbox quota for a specified organization and user.
-
#update_mobile_device_access_rule(params = {}) ⇒ Struct
Updates a mobile device access rule for the specified WorkMail organization.
-
#update_primary_email_address(params = {}) ⇒ Struct
Updates the primary email for a user, group, or resource.
-
#update_resource(params = {}) ⇒ Struct
Updates data for the resource.
-
#update_user(params = {}) ⇒ Struct
Updates data for the user.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#associate_delegate_to_resource(params = {}) ⇒ Struct
Adds a member (user or group) to the resource's set of delegates.
445 446 447 448 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 445 def associate_delegate_to_resource(params = {}, = {}) req = build_request(:associate_delegate_to_resource, params) req.send_request() end |
#associate_member_to_group(params = {}) ⇒ Struct
Adds a member (user or group) to the group's set.
495 496 497 498 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 495 def associate_member_to_group(params = {}, = {}) req = build_request(:associate_member_to_group, params) req.send_request() end |
#assume_impersonation_role(params = {}) ⇒ Types::AssumeImpersonationRoleResponse
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
532 533 534 535 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 532 def assume_impersonation_role(params = {}, = {}) req = build_request(:assume_impersonation_role, params) req.send_request() end |
#cancel_mailbox_export_job(params = {}) ⇒ Struct
Cancels a mailbox export job.
570 571 572 573 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 570 def cancel_mailbox_export_job(params = {}, = {}) req = build_request(:cancel_mailbox_export_job, params) req.send_request() end |
#create_alias(params = {}) ⇒ Struct
Adds an alias to the set of a given member (user or group) of WorkMail.
601 602 603 604 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 601 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_availability_configuration(params = {}) ⇒ Struct
Creates an AvailabilityConfiguration
for the given WorkMail
organization and domain.
655 656 657 658 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 655 def create_availability_configuration(params = {}, = {}) req = build_request(:create_availability_configuration, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
693 694 695 696 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 693 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_impersonation_role(params = {}) ⇒ Types::CreateImpersonationRoleResponse
Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
759 760 761 762 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 759 def create_impersonation_role(params = {}, = {}) req = build_request(:create_impersonation_role, params) req.send_request() end |
#create_mobile_device_access_rule(params = {}) ⇒ Types::CreateMobileDeviceAccessRuleResponse
Creates a new mobile device access rule for the specified WorkMail organization.
844 845 846 847 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 844 def create_mobile_device_access_rule(params = {}, = {}) req = build_request(:create_mobile_device_access_rule, params) req.send_request() end |
#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse
Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
926 927 928 929 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 926 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
973 974 975 976 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 973 def create_resource(params = {}, = {}) req = build_request(:create_resource, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1036 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_access_control_rule(params = {}) ⇒ Struct
Deletes an access control rule for the specified WorkMail organization.
1069 1070 1071 1072 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1069 def delete_access_control_rule(params = {}, = {}) req = build_request(:delete_access_control_rule, params) req.send_request() end |
#delete_alias(params = {}) ⇒ Struct
Remove one or more specified aliases from a set of aliases for a given user.
1103 1104 1105 1106 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1103 def delete_alias(params = {}, = {}) req = build_request(:delete_alias, params) req.send_request() end |
#delete_availability_configuration(params = {}) ⇒ Struct
Deletes the AvailabilityConfiguration
for the given WorkMail
organization and domain.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1131 def delete_availability_configuration(params = {}, = {}) req = build_request(:delete_availability_configuration, params) req.send_request() end |
#delete_email_monitoring_configuration(params = {}) ⇒ Struct
Deletes the email monitoring configuration for a specified organization.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1155 def delete_email_monitoring_configuration(params = {}, = {}) req = build_request(:delete_email_monitoring_configuration, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group from WorkMail.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1189 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_impersonation_role(params = {}) ⇒ Struct
Deletes an impersonation role for the given WorkMail organization.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1215 def delete_impersonation_role(params = {}, = {}) req = build_request(:delete_impersonation_role, params) req.send_request() end |
#delete_mailbox_permissions(params = {}) ⇒ Struct
Deletes permissions granted to a member (user or group).
1268 1269 1270 1271 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1268 def (params = {}, = {}) req = build_request(:delete_mailbox_permissions, params) req.send_request() end |
#delete_mobile_device_access_override(params = {}) ⇒ Struct
Deletes the mobile device access override for the given WorkMail organization, user, and device.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1315 def delete_mobile_device_access_override(params = {}, = {}) req = build_request(:delete_mobile_device_access_override, params) req.send_request() end |
#delete_mobile_device_access_rule(params = {}) ⇒ Struct
Deletes a mobile device access rule for the specified WorkMail organization.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1348 def delete_mobile_device_access_rule(params = {}, = {}) req = build_request(:delete_mobile_device_access_rule, params) req.send_request() end |
#delete_organization(params = {}) ⇒ Types::DeleteOrganizationResponse
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1402 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1436 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_retention_policy(params = {}) ⇒ Struct
Deletes the specified retention policy from the specified organization.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1463 def delete_retention_policy(params = {}, = {}) req = build_request(:delete_retention_policy, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user from WorkMail and all subsequent systems. Before you
can delete a user, the user state must be DISABLED
. Use the
DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
1502 1503 1504 1505 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1502 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#deregister_from_work_mail(params = {}) ⇒ Struct
Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1543 def deregister_from_work_mail(params = {}, = {}) req = build_request(:deregister_from_work_mail, params) req.send_request() end |
#deregister_mail_domain(params = {}) ⇒ Struct
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1572 def deregister_mail_domain(params = {}, = {}) req = build_request(:deregister_mail_domain, params) req.send_request() end |
#describe_email_monitoring_configuration(params = {}) ⇒ Types::DescribeEmailMonitoringConfigurationResponse
Describes the current email monitoring configuration for a specified organization.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1604 def describe_email_monitoring_configuration(params = {}, = {}) req = build_request(:describe_email_monitoring_configuration, params) req.send_request() end |
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Returns basic details about an entity in WorkMail.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1640 def describe_entity(params = {}, = {}) req = build_request(:describe_entity, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns the data available for the group.
1694 1695 1696 1697 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1694 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_inbound_dmarc_settings(params = {}) ⇒ Types::DescribeInboundDmarcSettingsResponse
Lists the settings in a DMARC policy for a specified organization.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1722 def describe_inbound_dmarc_settings(params = {}, = {}) req = build_request(:describe_inbound_dmarc_settings, params) req.send_request() end |
#describe_mailbox_export_job(params = {}) ⇒ Types::DescribeMailboxExportJobResponse
Describes the current status of a mailbox export job.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1776 def describe_mailbox_export_job(params = {}, = {}) req = build_request(:describe_mailbox_export_job, params) req.send_request() end |
#describe_organization(params = {}) ⇒ Types::DescribeOrganizationResponse
Provides more information regarding a given organization based on its identifier.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1825 def describe_organization(params = {}, = {}) req = build_request(:describe_organization, params) req.send_request() end |
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Returns the data available for the resource.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1887 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1973 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#disassociate_delegate_from_resource(params = {}) ⇒ Struct
Removes a member from the resource's set of delegates.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2024 def disassociate_delegate_from_resource(params = {}, = {}) req = build_request(:disassociate_delegate_from_resource, params) req.send_request() end |
#disassociate_member_from_group(params = {}) ⇒ Struct
Removes a member from a group.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2074 def disassociate_member_from_group(params = {}, = {}) req = build_request(:disassociate_member_from_group, params) req.send_request() end |
#get_access_control_effect(params = {}) ⇒ Types::GetAccessControlEffectResponse
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
2127 2128 2129 2130 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2127 def get_access_control_effect(params = {}, = {}) req = build_request(:get_access_control_effect, params) req.send_request() end |
#get_default_retention_policy(params = {}) ⇒ Types::GetDefaultRetentionPolicyResponse
Gets the default retention policy details for the specified organization.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2165 def get_default_retention_policy(params = {}, = {}) req = build_request(:get_default_retention_policy, params) req.send_request() end |
#get_impersonation_role(params = {}) ⇒ Types::GetImpersonationRoleResponse
Gets the impersonation role details for the given WorkMail organization.
2219 2220 2221 2222 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2219 def get_impersonation_role(params = {}, = {}) req = build_request(:get_impersonation_role, params) req.send_request() end |
#get_impersonation_role_effect(params = {}) ⇒ Types::GetImpersonationRoleEffectResponse
Tests whether the given impersonation role can impersonate a target user.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2270 def get_impersonation_role_effect(params = {}, = {}) req = build_request(:get_impersonation_role_effect, params) req.send_request() end |
#get_mail_domain(params = {}) ⇒ Types::GetMailDomainResponse
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
2314 2315 2316 2317 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2314 def get_mail_domain(params = {}, = {}) req = build_request(:get_mail_domain, params) req.send_request() end |
#get_mailbox_details(params = {}) ⇒ Types::GetMailboxDetailsResponse
Requests a user's mailbox details for a specified organization and user.
2360 2361 2362 2363 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2360 def get_mailbox_details(params = {}, = {}) req = build_request(:get_mailbox_details, params) req.send_request() end |
#get_mobile_device_access_effect(params = {}) ⇒ Types::GetMobileDeviceAccessEffectResponse
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
2411 2412 2413 2414 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2411 def get_mobile_device_access_effect(params = {}, = {}) req = build_request(:get_mobile_device_access_effect, params) req.send_request() end |
#get_mobile_device_access_override(params = {}) ⇒ Types::GetMobileDeviceAccessOverrideResponse
Gets the mobile device access override for the given WorkMail organization, user, and device.
2467 2468 2469 2470 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2467 def get_mobile_device_access_override(params = {}, = {}) req = build_request(:get_mobile_device_access_override, params) req.send_request() end |
#list_access_control_rules(params = {}) ⇒ Types::ListAccessControlRulesResponse
Lists the access control rules for the specified organization.
2516 2517 2518 2519 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2516 def list_access_control_rules(params = {}, = {}) req = build_request(:list_access_control_rules, params) req.send_request() end |
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Creates a paginated call to list the aliases associated with a given entity.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2563 def list_aliases(params = {}, = {}) req = build_request(:list_aliases, params) req.send_request() end |
#list_availability_configurations(params = {}) ⇒ Types::ListAvailabilityConfigurationsResponse
List all the AvailabilityConfiguration
's for the given WorkMail
organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2613 2614 2615 2616 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2613 def list_availability_configurations(params = {}, = {}) req = build_request(:list_availability_configurations, params) req.send_request() end |
#list_group_members(params = {}) ⇒ Types::ListGroupMembersResponse
Returns an overview of the members of a group. Users and groups can be members of a group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2676 2677 2678 2679 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2676 def list_group_members(params = {}, = {}) req = build_request(:list_group_members, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Returns summaries of the organization's groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2732 2733 2734 2735 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2732 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_groups_for_entity(params = {}) ⇒ Types::ListGroupsForEntityResponse
Returns all the groups to which an entity belongs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2795 2796 2797 2798 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2795 def list_groups_for_entity(params = {}, = {}) req = build_request(:list_groups_for_entity, params) req.send_request() end |
#list_impersonation_roles(params = {}) ⇒ Types::ListImpersonationRolesResponse
Lists all the impersonation roles for the given WorkMail organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2842 2843 2844 2845 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2842 def list_impersonation_roles(params = {}, = {}) req = build_request(:list_impersonation_roles, params) req.send_request() end |
#list_mail_domains(params = {}) ⇒ Types::ListMailDomainsResponse
Lists the mail domains in a given WorkMail organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2885 2886 2887 2888 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2885 def list_mail_domains(params = {}, = {}) req = build_request(:list_mail_domains, params) req.send_request() end |
#list_mailbox_export_jobs(params = {}) ⇒ Types::ListMailboxExportJobsResponse
Lists the mailbox export jobs started for the specified organization within the last seven days.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2935 def list_mailbox_export_jobs(params = {}, = {}) req = build_request(:list_mailbox_export_jobs, params) req.send_request() end |
#list_mailbox_permissions(params = {}) ⇒ Types::ListMailboxPermissionsResponse
Lists the mailbox permissions associated with a user, group, or resource mailbox.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2997 2998 2999 3000 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2997 def (params = {}, = {}) req = build_request(:list_mailbox_permissions, params) req.send_request() end |
#list_mobile_device_access_overrides(params = {}) ⇒ Types::ListMobileDeviceAccessOverridesResponse
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3062 3063 3064 3065 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3062 def list_mobile_device_access_overrides(params = {}, = {}) req = build_request(:list_mobile_device_access_overrides, params) req.send_request() end |
#list_mobile_device_access_rules(params = {}) ⇒ Types::ListMobileDeviceAccessRulesResponse
Lists the mobile device access rules for the specified WorkMail organization.
3113 3114 3115 3116 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3113 def list_mobile_device_access_rules(params = {}, = {}) req = build_request(:list_mobile_device_access_rules, params) req.send_request() end |
#list_organizations(params = {}) ⇒ Types::ListOrganizationsResponse
Returns summaries of the customer's organizations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3155 3156 3157 3158 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3155 def list_organizations(params = {}, = {}) req = build_request(:list_organizations, params) req.send_request() end |
#list_resource_delegates(params = {}) ⇒ Types::ListResourceDelegatesResponse
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3213 3214 3215 3216 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3213 def list_resource_delegates(params = {}, = {}) req = build_request(:list_resource_delegates, params) req.send_request() end |
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Returns summaries of the organization's resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3271 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an WorkMail organization resource.
3301 3302 3303 3304 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3301 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns summaries of the organization's users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3360 3361 3362 3363 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3360 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#put_access_control_rule(params = {}) ⇒ Struct
Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
3434 3435 3436 3437 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3434 def put_access_control_rule(params = {}, = {}) req = build_request(:put_access_control_rule, params) req.send_request() end |
#put_email_monitoring_configuration(params = {}) ⇒ Struct
Creates or updates the email monitoring configuration for a specified organization.
3468 3469 3470 3471 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3468 def put_email_monitoring_configuration(params = {}, = {}) req = build_request(:put_email_monitoring_configuration, params) req.send_request() end |
#put_inbound_dmarc_settings(params = {}) ⇒ Struct
Enables or disables a DMARC policy for a given organization.
3494 3495 3496 3497 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3494 def put_inbound_dmarc_settings(params = {}, = {}) req = build_request(:put_inbound_dmarc_settings, params) req.send_request() end |
#put_mailbox_permissions(params = {}) ⇒ Struct
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
3560 3561 3562 3563 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3560 def (params = {}, = {}) req = build_request(:put_mailbox_permissions, params) req.send_request() end |
#put_mobile_device_access_override(params = {}) ⇒ Struct
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
3609 3610 3611 3612 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3609 def put_mobile_device_access_override(params = {}, = {}) req = build_request(:put_mobile_device_access_override, params) req.send_request() end |
#put_retention_policy(params = {}) ⇒ Struct
Puts a retention policy to the specified organization.
3653 3654 3655 3656 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3653 def put_retention_policy(params = {}, = {}) req = build_request(:put_retention_policy, params) req.send_request() end |
#register_mail_domain(params = {}) ⇒ Struct
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
3689 3690 3691 3692 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3689 def register_mail_domain(params = {}, = {}) req = build_request(:register_mail_domain, params) req.send_request() end |
#register_to_work_mail(params = {}) ⇒ Struct
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
3744 3745 3746 3747 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3744 def register_to_work_mail(params = {}, = {}) req = build_request(:register_to_work_mail, params) req.send_request() end |
#reset_password(params = {}) ⇒ Struct
Allows the administrator to reset the password for a user.
3775 3776 3777 3778 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3775 def reset_password(params = {}, = {}) req = build_request(:reset_password, params) req.send_request() end |
#start_mailbox_export_job(params = {}) ⇒ Types::StartMailboxExportJobResponse
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. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
3855 3856 3857 3858 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3855 def start_mailbox_export_job(params = {}, = {}) req = build_request(:start_mailbox_export_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified WorkMailorganization resource.
3887 3888 3889 3890 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3887 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_availability_configuration(params = {}) ⇒ Types::TestAvailabilityConfigurationResponse
Performs a test on an availability provider to ensure that access is
allowed. For EWS, it verifies the provided credentials can be used to
successfully log in. For Lambda, it verifies that the Lambda function
can be invoked and that the resource access policy was configured to
deny anonymous access. An anonymous invocation is one done without
providing either a SourceArn
or SourceAccount
header.
EwsProvider
or LambdaProvider
) or the DomainName
parameter. If the
DomainName
parameter is provided, the configuration stored under the
DomainName
will be tested.
3951 3952 3953 3954 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3951 def test_availability_configuration(params = {}, = {}) req = build_request(:test_availability_configuration, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags the specified tags from the specified WorkMail organization resource.
3978 3979 3980 3981 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3978 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_availability_configuration(params = {}) ⇒ Struct
Updates an existing AvailabilityConfiguration
for the given WorkMail
organization and domain.
4027 4028 4029 4030 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4027 def update_availability_configuration(params = {}, = {}) req = build_request(:update_availability_configuration, params) req.send_request() end |
#update_default_mail_domain(params = {}) ⇒ Struct
Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
4055 4056 4057 4058 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4055 def update_default_mail_domain(params = {}, = {}) req = build_request(:update_default_mail_domain, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
Updates attibutes in a group.
4095 4096 4097 4098 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4095 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_impersonation_role(params = {}) ⇒ Struct
Updates an impersonation role for the given WorkMail organization.
4147 4148 4149 4150 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4147 def update_impersonation_role(params = {}, = {}) req = build_request(:update_impersonation_role, params) req.send_request() end |
#update_mailbox_quota(params = {}) ⇒ Struct
Updates a user's current mailbox quota for a specified organization and user.
4189 4190 4191 4192 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4189 def update_mailbox_quota(params = {}, = {}) req = build_request(:update_mailbox_quota, params) req.send_request() end |
#update_mobile_device_access_rule(params = {}) ⇒ Struct
Updates a mobile device access rule for the specified WorkMail organization.
4265 4266 4267 4268 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4265 def update_mobile_device_access_rule(params = {}, = {}) req = build_request(:update_mobile_device_access_rule, params) req.send_request() end |
#update_primary_email_address(params = {}) ⇒ Struct
Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
4310 4311 4312 4313 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4310 def update_primary_email_address(params = {}, = {}) req = build_request(:update_primary_email_address, params) req.send_request() end |
#update_resource(params = {}) ⇒ Struct
Updates data for the resource. To have the latest information, it must
be preceded by a DescribeResource call. The dataset in the request
should be the one expected when performing another DescribeResource
call.
4373 4374 4375 4376 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4373 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
Updates data for the user. To have the latest information, it must be
preceded by a DescribeUser call. The dataset in the request should be
the one expected when performing another DescribeUser
call.
4473 4474 4475 4476 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4473 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |