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.
-
#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 Amazon WorkMail.
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
-
#create_mobile_device_access_rule(params = {}) ⇒ Types::CreateMobileDeviceAccessRuleResponse
Creates a new mobile device access rule for the specified Amazon WorkMail organization.
-
#create_organization(params = {}) ⇒ Types::CreateOrganizationResponse
Creates a new Amazon WorkMail organization.
-
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new Amazon WorkMail resource.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user who can be used in Amazon 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_group(params = {}) ⇒ Struct
Deletes a group from Amazon WorkMail.
-
#delete_mailbox_permissions(params = {}) ⇒ Struct
Deletes permissions granted to a member (user or group).
-
#delete_mobile_device_access_rule(params = {}) ⇒ Struct
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
-
#delete_organization(params = {}) ⇒ Types::DeleteOrganizationResponse
Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon 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 Amazon WorkMail and all subsequent systems.
-
#deregister_from_work_mail(params = {}) ⇒ Struct
Mark a user, group, or resource as no longer used in Amazon WorkMail.
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns the data available for the group.
-
#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, or user ID.
-
#get_default_retention_policy(params = {}) ⇒ Types::GetDefaultRetentionPolicyResponse
Gets the default retention policy details for the specified organization.
-
#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.
-
#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_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_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_rules(params = {}) ⇒ Types::ListMobileDeviceAccessRulesResponse
Lists the mobile device access rules for the specified Amazon 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 Amazon 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_mailbox_permissions(params = {}) ⇒ Struct
Sets permissions for a user, group, or resource.
-
#put_retention_policy(params = {}) ⇒ Struct
Puts a retention policy to the specified organization.
-
#register_to_work_mail(params = {}) ⇒ Struct
Registers an existing and disabled user, group, or resource for Amazon 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 Amazon WorkMail organization resource.
-
#untag_resource(params = {}) ⇒ Struct
Untags the specified tags from the specified Amazon WorkMail organization resource.
-
#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 Amazon 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.
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.
334 335 336 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 334 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.
365 366 367 368 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 365 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.
395 396 397 398 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 395 def associate_member_to_group(params = {}, = {}) req = build_request(:associate_member_to_group, params) req.send_request() end |
#cancel_mailbox_export_job(params = {}) ⇒ Struct
Cancels a mailbox export job.
433 434 435 436 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 433 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 Amazon WorkMail.
464 465 466 467 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 464 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
497 498 499 500 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 497 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_mobile_device_access_rule(params = {}) ⇒ Types::CreateMobileDeviceAccessRuleResponse
Creates a new mobile device access rule for the specified Amazon WorkMail organization.
582 583 584 585 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 582 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 Amazon 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 Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then set your default email domain from the Amazon 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 Amazon WorkMail Administrator Guide.
Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.
666 667 668 669 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 666 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new Amazon WorkMail resource.
704 705 706 707 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 704 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 Amazon WorkMail by calling the RegisterToWorkMail operation.
746 747 748 749 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 746 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.
773 774 775 776 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 773 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.
807 808 809 810 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 807 def delete_alias(params = {}, = {}) req = build_request(:delete_alias, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group from Amazon WorkMail.
833 834 835 836 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 833 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_mailbox_permissions(params = {}) ⇒ Struct
Deletes permissions granted to a member (user or group).
865 866 867 868 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 865 def (params = {}, = {}) req = build_request(:delete_mailbox_permissions, params) req.send_request() end |
#delete_mobile_device_access_rule(params = {}) ⇒ Struct
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
892 893 894 895 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 892 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 Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.
942 943 944 945 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 942 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
969 970 971 972 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 969 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.
996 997 998 999 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 996 def delete_retention_policy(params = {}, = {}) req = build_request(:delete_retention_policy, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user from Amazon 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1027 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 Amazon 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.
1057 1058 1059 1060 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1057 def deregister_from_work_mail(params = {}, = {}) req = build_request(:deregister_from_work_mail, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns the data available for the group.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1099 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_mailbox_export_job(params = {}) ⇒ Types::DescribeMailboxExportJobResponse
Describes the current status of a mailbox export job.
1153 1154 1155 1156 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1153 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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1198 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.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1247 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1293 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.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1325 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.
1355 1356 1357 1358 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1355 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, or user ID.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1401 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1439 def get_default_retention_policy(params = {}, = {}) req = build_request(:get_default_retention_policy, params) req.send_request() end |
#get_mailbox_details(params = {}) ⇒ Types::GetMailboxDetailsResponse
Requests a user's mailbox details for a specified organization and user.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1475 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 Amazon WorkMail organization for a particular user's attributes.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1526 def get_mobile_device_access_effect(params = {}, = {}) req = build_request(:get_mobile_device_access_effect, params) req.send_request() end |
#list_access_control_rules(params = {}) ⇒ Types::ListAccessControlRulesResponse
Lists the access control rules for the specified organization.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1571 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.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1618 def list_aliases(params = {}, = {}) req = build_request(:list_aliases, 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.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1671 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.
1718 1719 1720 1721 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1718 def list_groups(params = {}, = {}) req = build_request(:list_groups, 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.
1768 1769 1770 1771 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1768 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.
1820 1821 1822 1823 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1820 def (params = {}, = {}) req = build_request(:list_mailbox_permissions, params) req.send_request() end |
#list_mobile_device_access_rules(params = {}) ⇒ Types::ListMobileDeviceAccessRulesResponse
Lists the mobile device access rules for the specified Amazon WorkMail organization.
1871 1872 1873 1874 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1871 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.
1913 1914 1915 1916 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1913 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1962 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.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2010 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 Amazon WorkMail organization resource.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2040 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.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2089 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, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
2154 2155 2156 2157 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2154 def put_access_control_rule(params = {}, = {}) req = build_request(:put_access_control_rule, params) req.send_request() end |
#put_mailbox_permissions(params = {}) ⇒ Struct
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
2198 2199 2200 2201 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2198 def (params = {}, = {}) req = build_request(:put_mailbox_permissions, params) req.send_request() end |
#put_retention_policy(params = {}) ⇒ Struct
Puts a retention policy to the specified organization.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2242 def put_retention_policy(params = {}, = {}) req = build_request(:put_retention_policy, params) req.send_request() end |
#register_to_work_mail(params = {}) ⇒ Struct
Registers an existing and disabled user, group, or resource for Amazon 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.
2287 2288 2289 2290 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2287 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.
2318 2319 2320 2321 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2318 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 Amazon WorkMail Administrator Guide.
2387 2388 2389 2390 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2387 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 Amazon WorkMail organization resource.
2419 2420 2421 2422 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2419 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags the specified tags from the specified Amazon WorkMail organization resource.
2446 2447 2448 2449 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2446 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_mailbox_quota(params = {}) ⇒ Struct
Updates a user's current mailbox quota for a specified organization and user.
2478 2479 2480 2481 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2478 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 Amazon WorkMail organization.
2554 2555 2556 2557 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2554 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.
2587 2588 2589 2590 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2587 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.
2629 2630 2631 2632 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2629 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |