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
AvailabilityConfigurationfor 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_identity_center_application(params = {}) ⇒ Types::CreateIdentityCenterApplicationResponse
Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration.
-
#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
AvailabilityConfigurationfor 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_identity_center_application(params = {}) ⇒ Struct
Deletes the IAM Identity Center application from WorkMail.
-
#delete_identity_provider_configuration(params = {}) ⇒ Struct
Disables the integration between IdC and 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_personal_access_token(params = {}) ⇒ Struct
Deletes the Personal Access Token from the provided WorkMail 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_identity_provider_configuration(params = {}) ⇒ Types::DescribeIdentityProviderConfigurationResponse
Returns detailed information on the current IdC setup for the WorkMail organization.
-
#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.
-
#get_personal_access_token_metadata(params = {}) ⇒ Types::GetPersonalAccessTokenMetadataResponse
Requests details of a specific Personal Access Token within the WorkMail organization.
-
#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_personal_access_tokens(params = {}) ⇒ Types::ListPersonalAccessTokensResponse
Returns a summary of your Personal Access Tokens.
-
#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_identity_provider_configuration(params = {}) ⇒ Struct
Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users.
-
#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
AvailabilityConfigurationfor 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 attributes 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.
486 487 488 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 486 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.
536 537 538 539 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 536 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.
586 587 588 589 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 586 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.
623 624 625 626 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 623 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.
661 662 663 664 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 661 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.
692 693 694 695 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 692 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.
746 747 748 749 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 746 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.
784 785 786 787 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 784 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_identity_center_application(params = {}) ⇒ Types::CreateIdentityCenterApplicationResponse
Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.
826 827 828 829 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 826 def create_identity_center_application(params = {}, = {}) req = build_request(:create_identity_center_application, 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.
892 893 894 895 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 892 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.
977 978 979 980 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 977 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.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1059 def create_organization(params = {}, = {}) req = build_request(:create_organization, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::CreateResourceResponse
Creates a new WorkMail resource.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1106 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1175 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.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1208 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.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1242 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.
1270 1271 1272 1273 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1270 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.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1294 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.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1328 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_identity_center_application(params = {}) ⇒ Struct
Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1352 def delete_identity_center_application(params = {}, = {}) req = build_request(:delete_identity_center_application, params) req.send_request() end |
#delete_identity_provider_configuration(params = {}) ⇒ Struct
Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1377 def delete_identity_provider_configuration(params = {}, = {}) req = build_request(:delete_identity_provider_configuration, params) req.send_request() end |
#delete_impersonation_role(params = {}) ⇒ Struct
Deletes an impersonation role for the given WorkMail organization.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1403 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).
1456 1457 1458 1459 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1456 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1503 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.
1536 1537 1538 1539 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1536 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1595 def delete_organization(params = {}, = {}) req = build_request(:delete_organization, params) req.send_request() end |
#delete_personal_access_token(params = {}) ⇒ Struct
Deletes the Personal Access Token from the provided WorkMail Organization.
1622 1623 1624 1625 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1622 def delete_personal_access_token(params = {}, = {}) req = build_request(:delete_personal_access_token, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes the specified resource.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1656 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1683 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1722 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.
1763 1764 1765 1766 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1763 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.
1792 1793 1794 1795 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1792 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.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1824 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.
1860 1861 1862 1863 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1860 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1914 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_identity_provider_configuration(params = {}) ⇒ Types::DescribeIdentityProviderConfigurationResponse
Returns detailed information on the current IdC setup for the WorkMail organization.
1949 1950 1951 1952 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1949 def describe_identity_provider_configuration(params = {}, = {}) req = build_request(:describe_identity_provider_configuration, params) req.send_request() end |
#describe_inbound_dmarc_settings(params = {}) ⇒ Types::DescribeInboundDmarcSettingsResponse
Lists the settings in a DMARC policy for a specified organization.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 1977 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.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2031 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.
2080 2081 2082 2083 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2080 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.
2142 2143 2144 2145 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2142 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Provides information regarding the user.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2232 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.
2283 2284 2285 2286 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2283 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.
2333 2334 2335 2336 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2333 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.
2386 2387 2388 2389 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2386 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.
2424 2425 2426 2427 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2424 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.
2478 2479 2480 2481 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2478 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.
2529 2530 2531 2532 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2529 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.
2573 2574 2575 2576 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2573 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.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2619 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.
2670 2671 2672 2673 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2670 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.
2726 2727 2728 2729 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2726 def get_mobile_device_access_override(params = {}, = {}) req = build_request(:get_mobile_device_access_override, params) req.send_request() end |
#get_personal_access_token_metadata(params = {}) ⇒ Types::GetPersonalAccessTokenMetadataResponse
Requests details of a specific Personal Access Token within the WorkMail organization.
2772 2773 2774 2775 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2772 def (params = {}, = {}) req = build_request(:get_personal_access_token_metadata, params) req.send_request() end |
#list_access_control_rules(params = {}) ⇒ Types::ListAccessControlRulesResponse
Lists the access control rules for the specified organization.
2821 2822 2823 2824 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2821 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.
2868 2869 2870 2871 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2868 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.
2918 2919 2920 2921 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2918 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.
2981 2982 2983 2984 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 2981 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.
3037 3038 3039 3040 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3037 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.
3100 3101 3102 3103 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3100 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.
3147 3148 3149 3150 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3147 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.
3190 3191 3192 3193 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3190 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.
3240 3241 3242 3243 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3240 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.
3302 3303 3304 3305 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3302 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.
3367 3368 3369 3370 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3367 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.
3418 3419 3420 3421 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3418 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.
3460 3461 3462 3463 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3460 def list_organizations(params = {}, = {}) req = build_request(:list_organizations, params) req.send_request() end |
#list_personal_access_tokens(params = {}) ⇒ Types::ListPersonalAccessTokensResponse
Returns a summary of your Personal Access Tokens.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3512 3513 3514 3515 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3512 def list_personal_access_tokens(params = {}, = {}) req = build_request(:list_personal_access_tokens, 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.
3570 3571 3572 3573 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3570 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.
3628 3629 3630 3631 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3628 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.
3658 3659 3660 3661 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3658 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.
3720 3721 3722 3723 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3720 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.
3794 3795 3796 3797 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3794 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.
3829 3830 3831 3832 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3829 def put_email_monitoring_configuration(params = {}, = {}) req = build_request(:put_email_monitoring_configuration, params) req.send_request() end |
#put_identity_provider_configuration(params = {}) ⇒ Struct
Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.
3874 3875 3876 3877 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3874 def put_identity_provider_configuration(params = {}, = {}) req = build_request(:put_identity_provider_configuration, params) req.send_request() end |
#put_inbound_dmarc_settings(params = {}) ⇒ Struct
Enables or disables a DMARC policy for a given organization.
3900 3901 3902 3903 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3900 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.
3966 3967 3968 3969 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 3966 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.
4015 4016 4017 4018 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4015 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.
4059 4060 4061 4062 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4059 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.
4095 4096 4097 4098 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4095 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.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4150 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.
4181 4182 4183 4184 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4181 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.
4261 4262 4263 4264 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4261 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.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4293 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.
4357 4358 4359 4360 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4357 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.
4384 4385 4386 4387 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4384 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.
4433 4434 4435 4436 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4433 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.
4461 4462 4463 4464 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4461 def update_default_mail_domain(params = {}, = {}) req = build_request(:update_default_mail_domain, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
Updates attributes in a group.
4501 4502 4503 4504 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4501 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.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4553 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.
4595 4596 4597 4598 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4595 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.
4671 4672 4673 4674 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4671 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.
4716 4717 4718 4719 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4716 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.
4779 4780 4781 4782 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4779 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.
4885 4886 4887 4888 |
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/client.rb', line 4885 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |