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.
453 454 455 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 453 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.
503 504 505 506 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 503 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.
553 554 555 556 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 553 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.
590 591 592 593 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 590 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.
628 629 630 631 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 628 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.
659 660 661 662 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 659 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.
713 714 715 716 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 713 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.
751 752 753 754 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 751 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.
817 818 819 820 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 817 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.
902 903 904 905 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 902 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.
984 985 986 987 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 984 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
1031 1032 1033 1034 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1031 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.
1094 1095 1096 1097 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1094 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.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1127 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.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1161 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.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1189 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.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1213 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.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1247 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.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1273 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).
1326 1327 1328 1329 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1326 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.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1373 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.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1406 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.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1460 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1494 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.
1521 1522 1523 1524 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1521 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.
1560 1561 1562 1563 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1560 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.
1601 1602 1603 1604 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1601 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.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1630 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.
1662 1663 1664 1665 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1662 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.
1698 1699 1700 1701 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1698 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.
1752 1753 1754 1755 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1752 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.
1780 1781 1782 1783 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1780 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.
1834 1835 1836 1837 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1834 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.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1883 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.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1945 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2031 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.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2082 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.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2132 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.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2185 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.
2223 2224 2225 2226 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2223 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.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2277 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.
2328 2329 2330 2331 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2328 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.
2372 2373 2374 2375 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2372 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.
2418 2419 2420 2421 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2418 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.
2469 2470 2471 2472 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2469 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.
2525 2526 2527 2528 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2525 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.
2574 2575 2576 2577 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2574 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.
2621 2622 2623 2624 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2621 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.
2671 2672 2673 2674 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2671 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.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2734 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.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2790 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.
2853 2854 2855 2856 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2853 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.
2900 2901 2902 2903 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2900 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.
2943 2944 2945 2946 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2943 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.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2993 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.
3055 3056 3057 3058 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3055 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.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3120 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.
3171 3172 3173 3174 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3171 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.
3213 3214 3215 3216 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3213 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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3271 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.
3329 3330 3331 3332 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3329 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.
3359 3360 3361 3362 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3359 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.
3418 3419 3420 3421 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3418 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.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3492 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.
3526 3527 3528 3529 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3526 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.
3552 3553 3554 3555 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3552 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.
3618 3619 3620 3621 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3618 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.
3667 3668 3669 3670 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3667 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.
3711 3712 3713 3714 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3711 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.
3747 3748 3749 3750 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3747 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.
3802 3803 3804 3805 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3802 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.
3833 3834 3835 3836 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3833 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.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3913 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.
3945 3946 3947 3948 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3945 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.
4009 4010 4011 4012 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4009 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.
4036 4037 4038 4039 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4036 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.
4085 4086 4087 4088 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4085 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.
4113 4114 4115 4116 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4113 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.
4153 4154 4155 4156 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4153 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.
4205 4206 4207 4208 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4205 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.
4247 4248 4249 4250 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4247 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.
4323 4324 4325 4326 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4323 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.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4368 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.
4431 4432 4433 4434 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4431 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.
4531 4532 4533 4534 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4531 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |