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.
447 448 449 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 447 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.
497 498 499 500 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 497 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.
547 548 549 550 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 547 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.
584 585 586 587 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 584 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.
622 623 624 625 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 622 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.
653 654 655 656 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 653 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.
707 708 709 710 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 707 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.
745 746 747 748 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 745 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.
811 812 813 814 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 811 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.
896 897 898 899 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 896 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.
978 979 980 981 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 978 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
1025 1026 1027 1028 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1025 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.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1088 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.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1121 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.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1155 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.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1183 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.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1207 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.
1241 1242 1243 1244 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1241 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.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1267 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).
1320 1321 1322 1323 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1320 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.
1367 1368 1369 1370 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1367 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1400 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.
1454 1455 1456 1457 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1454 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1488 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.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1515 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1554 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1595 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.
1624 1625 1626 1627 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1624 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.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1656 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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1692 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.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1746 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.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1774 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.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1828 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.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1877 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.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1939 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2025 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.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2076 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2126 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.
2179 2180 2181 2182 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2179 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.
2217 2218 2219 2220 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2217 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.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2271 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.
2322 2323 2324 2325 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2322 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.
2366 2367 2368 2369 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2366 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.
2412 2413 2414 2415 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2412 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.
2463 2464 2465 2466 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2463 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.
2519 2520 2521 2522 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2519 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.
2568 2569 2570 2571 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2568 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2615 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.
2665 2666 2667 2668 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2665 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.
2728 2729 2730 2731 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2728 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.
2784 2785 2786 2787 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2784 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.
2847 2848 2849 2850 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2847 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.
2894 2895 2896 2897 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2894 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.
2937 2938 2939 2940 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2937 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.
2987 2988 2989 2990 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2987 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.
3049 3050 3051 3052 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3049 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.
3114 3115 3116 3117 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3114 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.
3165 3166 3167 3168 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3165 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.
3207 3208 3209 3210 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3207 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.
3265 3266 3267 3268 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3265 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.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3323 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.
3353 3354 3355 3356 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3353 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.
3412 3413 3414 3415 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3412 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.
3486 3487 3488 3489 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3486 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.
3520 3521 3522 3523 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3520 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.
3546 3547 3548 3549 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3546 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.
3612 3613 3614 3615 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3612 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.
3661 3662 3663 3664 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3661 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.
3705 3706 3707 3708 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3705 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.
3741 3742 3743 3744 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3741 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.
3796 3797 3798 3799 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3796 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.
3827 3828 3829 3830 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3827 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.
3907 3908 3909 3910 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3907 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.
3939 3940 3941 3942 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3939 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.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4003 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.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4030 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.
4079 4080 4081 4082 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4079 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.
4107 4108 4109 4110 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4107 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.
4147 4148 4149 4150 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4147 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.
4199 4200 4201 4202 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4199 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.
4241 4242 4243 4244 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4241 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.
4317 4318 4319 4320 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4317 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.
4362 4363 4364 4365 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4362 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.
4425 4426 4427 4428 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4425 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.
4525 4526 4527 4528 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4525 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |