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.
420 421 422 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 420 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.
470 471 472 473 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 470 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.
520 521 522 523 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 520 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.
557 558 559 560 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 557 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.
595 596 597 598 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 595 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.
626 627 628 629 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 626 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.
680 681 682 683 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 680 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.
718 719 720 721 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 718 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.
784 785 786 787 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 784 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.
869 870 871 872 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 869 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.
951 952 953 954 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 951 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
998 999 1000 1001 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 998 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.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1061 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.
1094 1095 1096 1097 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1094 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.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1128 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.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1156 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.
1180 1181 1182 1183 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1180 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.
1214 1215 1216 1217 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1214 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.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1240 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).
1293 1294 1295 1296 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1293 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.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1340 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.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1373 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.
1427 1428 1429 1430 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1427 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1461 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.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1488 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.
1527 1528 1529 1530 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1527 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.
1568 1569 1570 1571 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1568 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.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1597 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.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1629 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.
1665 1666 1667 1668 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1665 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.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1719 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.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1747 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.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1801 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.
1850 1851 1852 1853 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1850 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1912 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
1998 1999 2000 2001 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1998 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.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2049 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.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2099 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.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2152 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.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2190 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.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2244 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.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2295 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.
2339 2340 2341 2342 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2339 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.
2385 2386 2387 2388 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2385 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.
2436 2437 2438 2439 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2436 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.
2492 2493 2494 2495 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2492 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.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2541 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.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2588 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.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2638 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.
2701 2702 2703 2704 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2701 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.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2757 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.
2820 2821 2822 2823 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2820 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.
2867 2868 2869 2870 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2867 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.
2910 2911 2912 2913 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2910 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.
2960 2961 2962 2963 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2960 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.
3022 3023 3024 3025 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3022 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.
3087 3088 3089 3090 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3087 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.
3138 3139 3140 3141 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3138 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.
3180 3181 3182 3183 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3180 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.
3238 3239 3240 3241 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3238 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.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3296 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.
3326 3327 3328 3329 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3326 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.
3385 3386 3387 3388 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3385 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.
3459 3460 3461 3462 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3459 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.
3493 3494 3495 3496 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3493 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.
3519 3520 3521 3522 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3519 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.
3585 3586 3587 3588 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3585 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.
3634 3635 3636 3637 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3634 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.
3678 3679 3680 3681 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3678 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.
3714 3715 3716 3717 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3714 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.
3769 3770 3771 3772 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3769 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.
3800 3801 3802 3803 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3800 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.
3880 3881 3882 3883 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3880 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.
3912 3913 3914 3915 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3912 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.
3976 3977 3978 3979 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3976 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.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4003 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.
4052 4053 4054 4055 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4052 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.
4080 4081 4082 4083 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4080 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.
4120 4121 4122 4123 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4120 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.
4172 4173 4174 4175 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4172 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.
4214 4215 4216 4217 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4214 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.
4290 4291 4292 4293 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4290 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.
4335 4336 4337 4338 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4335 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.
4398 4399 4400 4401 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4398 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.
4498 4499 4500 4501 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4498 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |