Struct aws_sdk_workmail::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon WorkMail
Client for invoking operations on Amazon WorkMail. Each operation on Amazon WorkMail is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_workmail::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_workmail::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_workmail::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_delegate_to_resource(&self) -> AssociateDelegateToResource
pub fn associate_delegate_to_resource(&self) -> AssociateDelegateToResource
Constructs a fluent builder for the AssociateDelegateToResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization under which the resource exists.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The resource for which members (users or groups) are associated.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The member (user or group) to associate to the resource.
- On success, responds with
AssociateDelegateToResourceOutput
- On failure, responds with
SdkError<AssociateDelegateToResourceError>
sourcepub fn associate_member_to_group(&self) -> AssociateMemberToGroup
pub fn associate_member_to_group(&self) -> AssociateMemberToGroup
Constructs a fluent builder for the AssociateMemberToGroup
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization under which the group exists.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:The group to which the member (user or group) is associated.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The member (user or group) to associate to the group.
- On success, responds with
AssociateMemberToGroupOutput
- On failure, responds with
SdkError<AssociateMemberToGroupError>
sourcepub fn cancel_mailbox_export_job(&self) -> CancelMailboxExportJob
pub fn cancel_mailbox_export_job(&self) -> CancelMailboxExportJob
Constructs a fluent builder for the CancelMailboxExportJob
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token for the client request.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The job ID.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
- On success, responds with
CancelMailboxExportJobOutput
- On failure, responds with
SdkError<CancelMailboxExportJobError>
sourcepub fn create_alias(&self) -> CreateAlias
pub fn create_alias(&self) -> CreateAlias
Constructs a fluent builder for the CreateAlias
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization under which the member (user or group) exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The member (user or group) to which this alias is added.
alias(impl Into<String>)
/set_alias(Option<String>)
:The alias to add to the member set.
- On success, responds with
CreateAliasOutput
- On failure, responds with
SdkError<CreateAliasError>
sourcepub fn create_group(&self) -> CreateGroup
pub fn create_group(&self) -> CreateGroup
Constructs a fluent builder for the CreateGroup
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization under which the group is to be created.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the group.
- On success, responds with
CreateGroupOutput
with field(s):group_id(Option<String>)
:The identifier of the group.
- On failure, responds with
SdkError<CreateGroupError>
sourcepub fn create_mobile_device_access_rule(&self) -> CreateMobileDeviceAccessRule
pub fn create_mobile_device_access_rule(&self) -> CreateMobileDeviceAccessRule
Constructs a fluent builder for the CreateMobileDeviceAccessRule
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization under which the rule will be created.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token for the client request.
name(impl Into<String>)
/set_name(Option<String>)
:The rule name.
description(impl Into<String>)
/set_description(Option<String>)
:The rule description.
effect(MobileDeviceAccessRuleEffect)
/set_effect(Option<MobileDeviceAccessRuleEffect>)
:The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
.device_types(Vec<String>)
/set_device_types(Option<Vec<String>>)
:Device types that the rule will match.
not_device_types(Vec<String>)
/set_not_device_types(Option<Vec<String>>)
:Device types that the rule will not match. All other device types will match.
device_models(Vec<String>)
/set_device_models(Option<Vec<String>>)
:Device models that the rule will match.
not_device_models(Vec<String>)
/set_not_device_models(Option<Vec<String>>)
:Device models that the rule will not match. All other device models will match.
device_operating_systems(Vec<String>)
/set_device_operating_systems(Option<Vec<String>>)
:Device operating systems that the rule will match.
not_device_operating_systems(Vec<String>)
/set_not_device_operating_systems(Option<Vec<String>>)
:Device operating systems that the rule will not match. All other device operating systems will match.
device_user_agents(Vec<String>)
/set_device_user_agents(Option<Vec<String>>)
:Device user agents that the rule will match.
not_device_user_agents(Vec<String>)
/set_not_device_user_agents(Option<Vec<String>>)
:Device user agents that the rule will not match. All other device user agents will match.
- On success, responds with
CreateMobileDeviceAccessRuleOutput
with field(s):mobile_device_access_rule_id(Option<String>)
:The identifier for the newly created mobile device access rule.
- On failure, responds with
SdkError<CreateMobileDeviceAccessRuleError>
sourcepub fn create_organization(&self) -> CreateOrganization
pub fn create_organization(&self) -> CreateOrganization
Constructs a fluent builder for the CreateOrganization
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The AWS Directory Service directory ID.
alias(impl Into<String>)
/set_alias(Option<String>)
:The organization alias.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token associated with the request.
domains(Vec<Domain>)
/set_domains(Option<Vec<Domain>>)
:The email domains to associate with the organization.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.
enable_interoperability(bool)
/set_enable_interoperability(bool)
:When
true
, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set totrue
if an AD Connector directory ID is included in the request.
- On success, responds with
CreateOrganizationOutput
with field(s):organization_id(Option<String>)
:The organization ID.
- On failure, responds with
SdkError<CreateOrganizationError>
sourcepub fn create_resource(&self) -> CreateResource
pub fn create_resource(&self) -> CreateResource
Constructs a fluent builder for the CreateResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier associated with the organization for which the resource is created.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
r#type(ResourceType)
/set_type(Option<ResourceType>)
:The type of the new resource. The available types are
equipment
androom
.
- On success, responds with
CreateResourceOutput
with field(s):resource_id(Option<String>)
:The identifier of the new resource.
- On failure, responds with
SdkError<CreateResourceError>
sourcepub fn create_user(&self) -> CreateUser
pub fn create_user(&self) -> CreateUser
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization for which the user is created.
name(impl Into<String>)
/set_name(Option<String>)
:The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:The display name for the new user.
password(impl Into<String>)
/set_password(Option<String>)
:The password for the new user.
- On success, responds with
CreateUserOutput
with field(s):user_id(Option<String>)
:The identifier for the new user.
- On failure, responds with
SdkError<CreateUserError>
sourcepub fn delete_access_control_rule(&self) -> DeleteAccessControlRule
pub fn delete_access_control_rule(&self) -> DeleteAccessControlRule
Constructs a fluent builder for the DeleteAccessControlRule
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the access control rule.
- On success, responds with
DeleteAccessControlRuleOutput
- On failure, responds with
SdkError<DeleteAccessControlRuleError>
sourcepub fn delete_alias(&self) -> DeleteAlias
pub fn delete_alias(&self) -> DeleteAlias
Constructs a fluent builder for the DeleteAlias
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the user exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier for the member (user or group) from which to have the aliases removed.
alias(impl Into<String>)
/set_alias(Option<String>)
:The aliases to be removed from the user’s set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
- On success, responds with
DeleteAliasOutput
- On failure, responds with
SdkError<DeleteAliasError>
sourcepub fn delete_email_monitoring_configuration(
&self
) -> DeleteEmailMonitoringConfiguration
pub fn delete_email_monitoring_configuration(
&self
) -> DeleteEmailMonitoringConfiguration
Constructs a fluent builder for the DeleteEmailMonitoringConfiguration
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization from which the email monitoring configuration is deleted.
- On success, responds with
DeleteEmailMonitoringConfigurationOutput
- On failure, responds with
SdkError<DeleteEmailMonitoringConfigurationError>
sourcepub fn delete_group(&self) -> DeleteGroup
pub fn delete_group(&self) -> DeleteGroup
Constructs a fluent builder for the DeleteGroup
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization that contains the group.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:The identifier of the group to be deleted.
- On success, responds with
DeleteGroupOutput
- On failure, responds with
SdkError<DeleteGroupError>
sourcepub fn delete_mailbox_permissions(&self) -> DeleteMailboxPermissions
pub fn delete_mailbox_permissions(&self) -> DeleteMailboxPermissions
Constructs a fluent builder for the DeleteMailboxPermissions
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization under which the member (user or group) exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier of the member (user or group) that owns the mailbox.
grantee_id(impl Into<String>)
/set_grantee_id(Option<String>)
:The identifier of the member (user or group) for which to delete granted permissions.
- On success, responds with
DeleteMailboxPermissionsOutput
- On failure, responds with
SdkError<DeleteMailboxPermissionsError>
sourcepub fn delete_mobile_device_access_override(
&self
) -> DeleteMobileDeviceAccessOverride
pub fn delete_mobile_device_access_override(
&self
) -> DeleteMobileDeviceAccessOverride
Constructs a fluent builder for the DeleteMobileDeviceAccessOverride
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which the access override will be deleted.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The WorkMail user for which you want to delete the override. Accepts the following types of user identities:
-
User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
-
Email address:
user@domain.tld
-
User name:
user
-
device_id(impl Into<String>)
/set_device_id(Option<String>)
:The mobile device for which you delete the override.
DeviceId
is case insensitive.
- On success, responds with
DeleteMobileDeviceAccessOverrideOutput
- On failure, responds with
SdkError<DeleteMobileDeviceAccessOverrideError>
sourcepub fn delete_mobile_device_access_rule(&self) -> DeleteMobileDeviceAccessRule
pub fn delete_mobile_device_access_rule(&self) -> DeleteMobileDeviceAccessRule
Constructs a fluent builder for the DeleteMobileDeviceAccessRule
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization under which the rule will be deleted.
mobile_device_access_rule_id(impl Into<String>)
/set_mobile_device_access_rule_id(Option<String>)
:The identifier of the rule to be deleted.
- On success, responds with
DeleteMobileDeviceAccessRuleOutput
- On failure, responds with
SdkError<DeleteMobileDeviceAccessRuleError>
sourcepub fn delete_organization(&self) -> DeleteOrganization
pub fn delete_organization(&self) -> DeleteOrganization
Constructs a fluent builder for the DeleteOrganization
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token associated with the request.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
delete_directory(bool)
/set_delete_directory(bool)
:If true, deletes the AWS Directory Service directory associated with the organization.
- On success, responds with
DeleteOrganizationOutput
with field(s):organization_id(Option<String>)
:The organization ID.
state(Option<String>)
:The state of the organization.
- On failure, responds with
SdkError<DeleteOrganizationError>
sourcepub fn delete_resource(&self) -> DeleteResource
pub fn delete_resource(&self) -> DeleteResource
Constructs a fluent builder for the DeleteResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier associated with the organization from which the resource is deleted.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The identifier of the resource to be deleted.
- On success, responds with
DeleteResourceOutput
- On failure, responds with
SdkError<DeleteResourceError>
sourcepub fn delete_retention_policy(&self) -> DeleteRetentionPolicy
pub fn delete_retention_policy(&self) -> DeleteRetentionPolicy
Constructs a fluent builder for the DeleteRetentionPolicy
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
id(impl Into<String>)
/set_id(Option<String>)
:The retention policy ID.
- On success, responds with
DeleteRetentionPolicyOutput
- On failure, responds with
SdkError<DeleteRetentionPolicyError>
sourcepub fn delete_user(&self) -> DeleteUser
pub fn delete_user(&self) -> DeleteUser
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization that contains the user to be deleted.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user to be deleted.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
sourcepub fn deregister_from_work_mail(&self) -> DeregisterFromWorkMail
pub fn deregister_from_work_mail(&self) -> DeregisterFromWorkMail
Constructs a fluent builder for the DeregisterFromWorkMail
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the Amazon WorkMail entity exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier for the member (user or group) to be updated.
- On success, responds with
DeregisterFromWorkMailOutput
- On failure, responds with
SdkError<DeregisterFromWorkMailError>
sourcepub fn deregister_mail_domain(&self) -> DeregisterMailDomain
pub fn deregister_mail_domain(&self) -> DeregisterMailDomain
Constructs a fluent builder for the DeregisterMailDomain
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which the domain will be deregistered.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The domain to deregister in WorkMail and SES.
- On success, responds with
DeregisterMailDomainOutput
- On failure, responds with
SdkError<DeregisterMailDomainError>
sourcepub fn describe_email_monitoring_configuration(
&self
) -> DescribeEmailMonitoringConfiguration
pub fn describe_email_monitoring_configuration(
&self
) -> DescribeEmailMonitoringConfiguration
Constructs a fluent builder for the DescribeEmailMonitoringConfiguration
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization for which the email monitoring configuration is described.
- On success, responds with
DescribeEmailMonitoringConfigurationOutput
with field(s):role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
log_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
- On failure, responds with
SdkError<DescribeEmailMonitoringConfigurationError>
sourcepub fn describe_group(&self) -> DescribeGroup
pub fn describe_group(&self) -> DescribeGroup
Constructs a fluent builder for the DescribeGroup
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the group exists.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:The identifier for the group to be described.
- On success, responds with
DescribeGroupOutput
with field(s):group_id(Option<String>)
:The identifier of the described group.
name(Option<String>)
:The name of the described group.
email(Option<String>)
:The email of the described group.
state(Option<EntityState>)
:The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
enabled_date(Option<DateTime>)
:The date and time when a user was registered to WorkMail, in UNIX epoch time format.
disabled_date(Option<DateTime>)
:The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
- On failure, responds with
SdkError<DescribeGroupError>
sourcepub fn describe_inbound_dmarc_settings(&self) -> DescribeInboundDmarcSettings
pub fn describe_inbound_dmarc_settings(&self) -> DescribeInboundDmarcSettings
Constructs a fluent builder for the DescribeInboundDmarcSettings
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:Lists the ID of the given organization.
- On success, responds with
DescribeInboundDmarcSettingsOutput
with field(s):enforced(bool)
:Lists the enforcement setting of the applied policy.
- On failure, responds with
SdkError<DescribeInboundDmarcSettingsError>
sourcepub fn describe_mailbox_export_job(&self) -> DescribeMailboxExportJob
pub fn describe_mailbox_export_job(&self) -> DescribeMailboxExportJob
Constructs a fluent builder for the DescribeMailboxExportJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The mailbox export job ID.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
- On success, responds with
DescribeMailboxExportJobOutput
with field(s):entity_id(Option<String>)
:The identifier of the user or resource associated with the mailbox.
description(Option<String>)
:The mailbox export job description.
role_arn(Option<String>)
:The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
kms_key_arn(Option<String>)
:The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
s3_bucket_name(Option<String>)
:The name of the S3 bucket.
s3_prefix(Option<String>)
:The S3 bucket prefix.
s3_path(Option<String>)
:The path to the S3 bucket and file that the mailbox export job is exporting to.
estimated_progress(i32)
:The estimated progress of the mailbox export job, in percentage points.
state(Option<MailboxExportJobState>)
:The state of the mailbox export job.
error_info(Option<String>)
:Error information for failed mailbox export jobs.
start_time(Option<DateTime>)
:The mailbox export job start timestamp.
end_time(Option<DateTime>)
:The mailbox export job end timestamp.
- On failure, responds with
SdkError<DescribeMailboxExportJobError>
sourcepub fn describe_organization(&self) -> DescribeOrganization
pub fn describe_organization(&self) -> DescribeOrganization
Constructs a fluent builder for the DescribeOrganization
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization to be described.
- On success, responds with
DescribeOrganizationOutput
with field(s):organization_id(Option<String>)
:The identifier of an organization.
alias(Option<String>)
:The alias for an organization.
state(Option<String>)
:The state of an organization.
directory_id(Option<String>)
:The identifier for the directory associated with an Amazon WorkMail organization.
directory_type(Option<String>)
:The type of directory associated with the WorkMail organization.
default_mail_domain(Option<String>)
:The default mail domain associated with the organization.
completed_date(Option<DateTime>)
:The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
error_message(Option<String>)
:(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the organization.
- On failure, responds with
SdkError<DescribeOrganizationError>
sourcepub fn describe_resource(&self) -> DescribeResource
pub fn describe_resource(&self) -> DescribeResource
Constructs a fluent builder for the DescribeResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier associated with the organization for which the resource is described.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The identifier of the resource to be described.
- On success, responds with
DescribeResourceOutput
with field(s):resource_id(Option<String>)
:The identifier of the described resource.
email(Option<String>)
:The email of the described resource.
name(Option<String>)
:The name of the described resource.
r#type(Option<ResourceType>)
:The type of the described resource.
booking_options(Option<BookingOptions>)
:The booking options for the described resource.
state(Option<EntityState>)
:The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
enabled_date(Option<DateTime>)
:The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
disabled_date(Option<DateTime>)
:The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
- On failure, responds with
SdkError<DescribeResourceError>
sourcepub fn describe_user(&self) -> DescribeUser
pub fn describe_user(&self) -> DescribeUser
Constructs a fluent builder for the DescribeUser
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the user exists.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier for the user to be described.
- On success, responds with
DescribeUserOutput
with field(s):user_id(Option<String>)
:The identifier for the described user.
name(Option<String>)
:The name for the user.
email(Option<String>)
:The email of the user.
display_name(Option<String>)
:The display name of the user.
state(Option<EntityState>)
:The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
user_role(Option<UserRole>)
:In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.
enabled_date(Option<DateTime>)
:The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
disabled_date(Option<DateTime>)
:The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
- On failure, responds with
SdkError<DescribeUserError>
sourcepub fn disassociate_delegate_from_resource(
&self
) -> DisassociateDelegateFromResource
pub fn disassociate_delegate_from_resource(
&self
) -> DisassociateDelegateFromResource
Constructs a fluent builder for the DisassociateDelegateFromResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the resource exists.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The identifier of the resource from which delegates’ set members are removed.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier for the member (user, group) to be removed from the resource’s delegates.
- On success, responds with
DisassociateDelegateFromResourceOutput
- On failure, responds with
SdkError<DisassociateDelegateFromResourceError>
sourcepub fn disassociate_member_from_group(&self) -> DisassociateMemberFromGroup
pub fn disassociate_member_from_group(&self) -> DisassociateMemberFromGroup
Constructs a fluent builder for the DisassociateMemberFromGroup
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the group exists.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:The identifier for the group from which members are removed.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The identifier for the member to be removed to the group.
- On success, responds with
DisassociateMemberFromGroupOutput
- On failure, responds with
SdkError<DisassociateMemberFromGroupError>
sourcepub fn get_access_control_effect(&self) -> GetAccessControlEffect
pub fn get_access_control_effect(&self) -> GetAccessControlEffect
Constructs a fluent builder for the GetAccessControlEffect
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization.
ip_address(impl Into<String>)
/set_ip_address(Option<String>)
:The IPv4 address.
action(impl Into<String>)
/set_action(Option<String>)
:The access protocol action. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
GetAccessControlEffectOutput
with field(s):effect(Option<AccessControlRuleEffect>)
:The rule effect.
matched_rules(Option<Vec<String>>)
:The rules that match the given parameters, resulting in an effect.
- On failure, responds with
SdkError<GetAccessControlEffectError>
sourcepub fn get_default_retention_policy(&self) -> GetDefaultRetentionPolicy
pub fn get_default_retention_policy(&self) -> GetDefaultRetentionPolicy
Constructs a fluent builder for the GetDefaultRetentionPolicy
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
- On success, responds with
GetDefaultRetentionPolicyOutput
with field(s):id(Option<String>)
:The retention policy ID.
name(Option<String>)
:The retention policy name.
description(Option<String>)
:The retention policy description.
folder_configurations(Option<Vec<FolderConfiguration>>)
:The retention policy folder configurations.
- On failure, responds with
SdkError<GetDefaultRetentionPolicyError>
sourcepub fn get_mailbox_details(&self) -> GetMailboxDetails
pub fn get_mailbox_details(&self) -> GetMailboxDetails
Constructs a fluent builder for the GetMailboxDetails
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization that contains the user whose mailbox details are being requested.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier for the user whose mailbox details are being requested.
- On success, responds with
GetMailboxDetailsOutput
with field(s):mailbox_quota(Option<i32>)
:The maximum allowed mailbox size, in MB, for the specified user.
mailbox_size(f64)
:The current mailbox size, in MB, for the specified user.
- On failure, responds with
SdkError<GetMailboxDetailsError>
sourcepub fn get_mail_domain(&self) -> GetMailDomain
pub fn get_mail_domain(&self) -> GetMailDomain
Constructs a fluent builder for the GetMailDomain
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which the domain is retrieved.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The domain from which you want to retrieve details.
- On success, responds with
GetMailDomainOutput
with field(s):records(Option<Vec<DnsRecord>>)
:A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.
is_test_domain(bool)
:Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
is_default(bool)
:Specifies whether the domain is the default domain for your organization.
ownership_verification_status(Option<DnsRecordVerificationStatus>)
:Indicates the status of the domain ownership verification.
dkim_verification_status(Option<DnsRecordVerificationStatus>)
:Indicates the status of a DKIM verification.
- On failure, responds with
SdkError<GetMailDomainError>
sourcepub fn get_mobile_device_access_effect(&self) -> GetMobileDeviceAccessEffect
pub fn get_mobile_device_access_effect(&self) -> GetMobileDeviceAccessEffect
Constructs a fluent builder for the GetMobileDeviceAccessEffect
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization to simulate the access effect for.
device_type(impl Into<String>)
/set_device_type(Option<String>)
:Device type the simulated user will report.
device_model(impl Into<String>)
/set_device_model(Option<String>)
:Device model the simulated user will report.
device_operating_system(impl Into<String>)
/set_device_operating_system(Option<String>)
:Device operating system the simulated user will report.
device_user_agent(impl Into<String>)
/set_device_user_agent(Option<String>)
:Device user agent the simulated user will report.
- On success, responds with
GetMobileDeviceAccessEffectOutput
with field(s):effect(Option<MobileDeviceAccessRuleEffect>)
:The effect of the simulated access,
ALLOW
orDENY
, after evaluating mobile device access rules in the Amazon WorkMail organization for the simulated user parameters.matched_rules(Option<Vec<MobileDeviceAccessMatchedRule>>)
:A list of the rules which matched the simulated user input and produced the effect.
- On failure, responds with
SdkError<GetMobileDeviceAccessEffectError>
sourcepub fn get_mobile_device_access_override(&self) -> GetMobileDeviceAccessOverride
pub fn get_mobile_device_access_override(&self) -> GetMobileDeviceAccessOverride
Constructs a fluent builder for the GetMobileDeviceAccessOverride
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization to which you want to apply the override.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:Identifies the WorkMail user for the override. Accepts the following types of user identities:
-
User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
-
Email address:
user@domain.tld
-
User name:
user
-
device_id(impl Into<String>)
/set_device_id(Option<String>)
:The mobile device to which the override applies.
DeviceId
is case insensitive.
- On success, responds with
GetMobileDeviceAccessOverrideOutput
with field(s):user_id(Option<String>)
:The WorkMail user to which the access override applies.
device_id(Option<String>)
:The device to which the access override applies.
effect(Option<MobileDeviceAccessRuleEffect>)
:The effect of the override,
ALLOW
orDENY
.description(Option<String>)
:A description of the override.
date_created(Option<DateTime>)
:The date the override was first created.
date_modified(Option<DateTime>)
:The date the description was last modified.
- On failure, responds with
SdkError<GetMobileDeviceAccessOverrideError>
sourcepub fn list_access_control_rules(&self) -> ListAccessControlRules
pub fn list_access_control_rules(&self) -> ListAccessControlRules
Constructs a fluent builder for the ListAccessControlRules
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization.
- On success, responds with
ListAccessControlRulesOutput
with field(s):rules(Option<Vec<AccessControlRule>>)
:The access control rules.
- On failure, responds with
SdkError<ListAccessControlRulesError>
sourcepub fn list_aliases(&self) -> ListAliases
pub fn list_aliases(&self) -> ListAliases
Constructs a fluent builder for the ListAliases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the entity exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier for the entity for which to list the aliases.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListAliasesOutput
with field(s):aliases(Option<Vec<String>>)
:The entity’s paginated aliases.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
- On failure, responds with
SdkError<ListAliasesError>
sourcepub fn list_group_members(&self) -> ListGroupMembers
pub fn list_group_members(&self) -> ListGroupMembers
Constructs a fluent builder for the ListGroupMembers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the group exists.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:The identifier for the group to which the members (users or groups) are associated.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListGroupMembersOutput
with field(s):members(Option<Vec<Member>>)
:The members associated to the group.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
- On failure, responds with
SdkError<ListGroupMembersError>
sourcepub fn list_groups(&self) -> ListGroups
pub fn list_groups(&self) -> ListGroups
Constructs a fluent builder for the ListGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the groups exist.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListGroupsOutput
with field(s):groups(Option<Vec<Group>>)
:The overview of groups for an organization.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
- On failure, responds with
SdkError<ListGroupsError>
sourcepub fn list_mailbox_export_jobs(&self) -> ListMailboxExportJobs
pub fn list_mailbox_export_jobs(&self) -> ListMailboxExportJobs
Constructs a fluent builder for the ListMailboxExportJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListMailboxExportJobsOutput
with field(s):jobs(Option<Vec<MailboxExportJob>>)
:The mailbox export job details.
next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListMailboxExportJobsError>
sourcepub fn list_mailbox_permissions(&self) -> ListMailboxPermissions
pub fn list_mailbox_permissions(&self) -> ListMailboxPermissions
Constructs a fluent builder for the ListMailboxPermissions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization under which the user, group, or resource exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier of the user, group, or resource for which to list mailbox permissions.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListMailboxPermissionsOutput
with field(s):permissions(Option<Vec<Permission>>)
:One page of the user, group, or resource mailbox permissions.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
- On failure, responds with
SdkError<ListMailboxPermissionsError>
sourcepub fn list_mail_domains(&self) -> ListMailDomains
pub fn list_mail_domains(&self) -> ListMailDomains
Constructs a fluent builder for the ListMailDomains
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which to list domains.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not require a token.
- On success, responds with
ListMailDomainsOutput
with field(s):mail_domains(Option<Vec<MailDomainSummary>>)
:The list of mail domain summaries, specifying domains that exist in the specified Amazon WorkMail organization, along with the information about whether the domain is or isn’t the default.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value becomes
null
when there are no more results to return.
- On failure, responds with
SdkError<ListMailDomainsError>
sourcepub fn list_mobile_device_access_overrides(
&self
) -> ListMobileDeviceAccessOverrides
pub fn list_mobile_device_access_overrides(
&self
) -> ListMobileDeviceAccessOverrides
Constructs a fluent builder for the ListMobileDeviceAccessOverrides
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization under which to list mobile device access overrides.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:
-
User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
-
Email address:
user@domain.tld
-
User name:
user
-
device_id(impl Into<String>)
/set_device_id(Option<String>)
:The mobile device to which the access override applies.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not require a token.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListMobileDeviceAccessOverridesOutput
with field(s):overrides(Option<Vec<MobileDeviceAccessOverride>>)
:The list of mobile device access overrides that exist for the specified Amazon WorkMail organization and user.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
- On failure, responds with
SdkError<ListMobileDeviceAccessOverridesError>
sourcepub fn list_mobile_device_access_rules(&self) -> ListMobileDeviceAccessRules
pub fn list_mobile_device_access_rules(&self) -> ListMobileDeviceAccessRules
Constructs a fluent builder for the ListMobileDeviceAccessRules
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which to list the rules.
- On success, responds with
ListMobileDeviceAccessRulesOutput
with field(s):rules(Option<Vec<MobileDeviceAccessRule>>)
:The list of mobile device access rules that exist under the specified Amazon WorkMail organization.
- On failure, responds with
SdkError<ListMobileDeviceAccessRulesError>
sourcepub fn list_organizations(&self) -> ListOrganizations
pub fn list_organizations(&self) -> ListOrganizations
Constructs a fluent builder for the ListOrganizations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListOrganizationsOutput
with field(s):organization_summaries(Option<Vec<OrganizationSummary>>)
:The overview of owned organizations presented as a list of organization summaries.
next_token(Option<String>)
:The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
- On failure, responds with
SdkError<ListOrganizationsError>
sourcepub fn list_resource_delegates(&self) -> ListResourceDelegates
pub fn list_resource_delegates(&self) -> ListResourceDelegates
Constructs a fluent builder for the ListResourceDelegates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization that contains the resource for which delegates are listed.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The identifier for the resource whose delegates are listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token used to paginate through the delegates associated with a resource.
max_results(i32)
/set_max_results(Option<i32>)
:The number of maximum results in a page.
- On success, responds with
ListResourceDelegatesOutput
with field(s):delegates(Option<Vec<Delegate>>)
:One page of the resource’s delegates.
next_token(Option<String>)
:The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.
- On failure, responds with
SdkError<ListResourceDelegatesError>
sourcepub fn list_resources(&self) -> ListResources
pub fn list_resources(&self) -> ListResources
Constructs a fluent builder for the ListResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the resources exist.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListResourcesOutput
with field(s):resources(Option<Vec<Resource>>)
:One page of the organization’s resource representation.
next_token(Option<String>)
:The token used to paginate through all the organization’s resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
- On failure, responds with
SdkError<ListResourcesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tag key-value pairs.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn list_users(&self) -> ListUsers
pub fn list_users(&self) -> ListUsers
Constructs a fluent builder for the ListUsers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the users exist.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListUsersOutput
with field(s):users(Option<Vec<User>>)
:The overview of users for an organization.
next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
- On failure, responds with
SdkError<ListUsersError>
sourcepub fn put_access_control_rule(&self) -> PutAccessControlRule
pub fn put_access_control_rule(&self) -> PutAccessControlRule
Constructs a fluent builder for the PutAccessControlRule
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The rule name.
effect(AccessControlRuleEffect)
/set_effect(Option<AccessControlRuleEffect>)
:The rule effect.
description(impl Into<String>)
/set_description(Option<String>)
:The rule description.
ip_ranges(Vec<String>)
/set_ip_ranges(Option<Vec<String>>)
:IPv4 CIDR ranges to include in the rule.
not_ip_ranges(Vec<String>)
/set_not_ip_ranges(Option<Vec<String>>)
:IPv4 CIDR ranges to exclude from the rule.
actions(Vec<String>)
/set_actions(Option<Vec<String>>)
:Access protocol actions to include in the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.not_actions(Vec<String>)
/set_not_actions(Option<Vec<String>>)
:Access protocol actions to exclude from the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.user_ids(Vec<String>)
/set_user_ids(Option<Vec<String>>)
:User IDs to include in the rule.
not_user_ids(Vec<String>)
/set_not_user_ids(Option<Vec<String>>)
:User IDs to exclude from the rule.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization.
- On success, responds with
PutAccessControlRuleOutput
- On failure, responds with
SdkError<PutAccessControlRuleError>
sourcepub fn put_email_monitoring_configuration(
&self
) -> PutEmailMonitoringConfiguration
pub fn put_email_monitoring_configuration(
&self
) -> PutEmailMonitoringConfiguration
Constructs a fluent builder for the PutEmailMonitoringConfiguration
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization for which the email monitoring configuration is set.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
log_group_arn(impl Into<String>)
/set_log_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
- On success, responds with
PutEmailMonitoringConfigurationOutput
- On failure, responds with
SdkError<PutEmailMonitoringConfigurationError>
sourcepub fn put_inbound_dmarc_settings(&self) -> PutInboundDmarcSettings
pub fn put_inbound_dmarc_settings(&self) -> PutInboundDmarcSettings
Constructs a fluent builder for the PutInboundDmarcSettings
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization that you are applying the DMARC policy to.
enforced(bool)
/set_enforced(Option<bool>)
:Enforces or suspends a policy after it’s applied.
- On success, responds with
PutInboundDmarcSettingsOutput
- On failure, responds with
SdkError<PutInboundDmarcSettingsError>
sourcepub fn put_mailbox_permissions(&self) -> PutMailboxPermissions
pub fn put_mailbox_permissions(&self) -> PutMailboxPermissions
Constructs a fluent builder for the PutMailboxPermissions
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization under which the user, group, or resource exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier of the user, group, or resource for which to update mailbox permissions.
grantee_id(impl Into<String>)
/set_grantee_id(Option<String>)
:The identifier of the user, group, or resource to which to grant the permissions.
permission_values(Vec<PermissionType>)
/set_permission_values(Option<Vec<PermissionType>>)
:The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
- On success, responds with
PutMailboxPermissionsOutput
- On failure, responds with
SdkError<PutMailboxPermissionsError>
sourcepub fn put_mobile_device_access_override(&self) -> PutMobileDeviceAccessOverride
pub fn put_mobile_device_access_override(&self) -> PutMobileDeviceAccessOverride
Constructs a fluent builder for the PutMobileDeviceAccessOverride
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:Identifies the Amazon WorkMail organization for which you create the override.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The WorkMail user for which you create the override. Accepts the following types of user identities:
-
User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
-
Email address:
user@domain.tld
-
User name:
user
-
device_id(impl Into<String>)
/set_device_id(Option<String>)
:The mobile device for which you create the override.
DeviceId
is case insensitive.effect(MobileDeviceAccessRuleEffect)
/set_effect(Option<MobileDeviceAccessRuleEffect>)
:The effect of the override,
ALLOW
orDENY
.description(impl Into<String>)
/set_description(Option<String>)
:A description of the override.
- On success, responds with
PutMobileDeviceAccessOverrideOutput
- On failure, responds with
SdkError<PutMobileDeviceAccessOverrideError>
sourcepub fn put_retention_policy(&self) -> PutRetentionPolicy
pub fn put_retention_policy(&self) -> PutRetentionPolicy
Constructs a fluent builder for the PutRetentionPolicy
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization ID.
id(impl Into<String>)
/set_id(Option<String>)
:The retention policy ID.
name(impl Into<String>)
/set_name(Option<String>)
:The retention policy name.
description(impl Into<String>)
/set_description(Option<String>)
:The retention policy description.
folder_configurations(Vec<FolderConfiguration>)
/set_folder_configurations(Option<Vec<FolderConfiguration>>)
:The retention policy folder configurations.
- On success, responds with
PutRetentionPolicyOutput
- On failure, responds with
SdkError<PutRetentionPolicyError>
sourcepub fn register_mail_domain(&self) -> RegisterMailDomain
pub fn register_mail_domain(&self) -> RegisterMailDomain
Constructs a fluent builder for the RegisterMailDomain
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:Idempotency token used when retrying requests.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization under which you’re creating the domain.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the mail domain to create in Amazon WorkMail and SES.
- On success, responds with
RegisterMailDomainOutput
- On failure, responds with
SdkError<RegisterMailDomainError>
sourcepub fn register_to_work_mail(&self) -> RegisterToWorkMail
pub fn register_to_work_mail(&self) -> RegisterToWorkMail
Constructs a fluent builder for the RegisterToWorkMail
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization under which the user, group, or resource exists.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier for the user, group, or resource to be updated.
email(impl Into<String>)
/set_email(Option<String>)
:The email for the user, group, or resource to be updated.
- On success, responds with
RegisterToWorkMailOutput
- On failure, responds with
SdkError<RegisterToWorkMailError>
sourcepub fn reset_password(&self) -> ResetPassword
pub fn reset_password(&self) -> ResetPassword
Constructs a fluent builder for the ResetPassword
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier of the organization that contains the user for which the password is reset.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user for whom the password is reset.
password(impl Into<String>)
/set_password(Option<String>)
:The new password for the user.
- On success, responds with
ResetPasswordOutput
- On failure, responds with
SdkError<ResetPasswordError>
sourcepub fn start_mailbox_export_job(&self) -> StartMailboxExportJob
pub fn start_mailbox_export_job(&self) -> StartMailboxExportJob
Constructs a fluent builder for the StartMailboxExportJob
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token for the client request.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier associated with the organization.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The identifier of the user or resource associated with the mailbox.
description(impl Into<String>)
/set_description(Option<String>)
:The mailbox export job description.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:The name of the S3 bucket.
s3_prefix(impl Into<String>)
/set_s3_prefix(Option<String>)
:The S3 bucket prefix.
- On success, responds with
StartMailboxExportJobOutput
with field(s):job_id(Option<String>)
:The job ID.
- On failure, responds with
SdkError<StartMailboxExportJobError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_default_mail_domain(&self) -> UpdateDefaultMailDomain
pub fn update_default_mail_domain(&self) -> UpdateDefaultMailDomain
Constructs a fluent builder for the UpdateDefaultMailDomain
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization for which to list domains.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The domain name that will become the default domain.
- On success, responds with
UpdateDefaultMailDomainOutput
- On failure, responds with
SdkError<UpdateDefaultMailDomainError>
sourcepub fn update_mailbox_quota(&self) -> UpdateMailboxQuota
pub fn update_mailbox_quota(&self) -> UpdateMailboxQuota
Constructs a fluent builder for the UpdateMailboxQuota
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier for the organization that contains the user for whom to update the mailbox quota.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifer for the user for whom to update the mailbox quota.
mailbox_quota(i32)
/set_mailbox_quota(Option<i32>)
:The updated mailbox quota, in MB, for the specified user.
- On success, responds with
UpdateMailboxQuotaOutput
- On failure, responds with
SdkError<UpdateMailboxQuotaError>
sourcepub fn update_mobile_device_access_rule(&self) -> UpdateMobileDeviceAccessRule
pub fn update_mobile_device_access_rule(&self) -> UpdateMobileDeviceAccessRule
Constructs a fluent builder for the UpdateMobileDeviceAccessRule
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The Amazon WorkMail organization under which the rule will be updated.
mobile_device_access_rule_id(impl Into<String>)
/set_mobile_device_access_rule_id(Option<String>)
:The identifier of the rule to be updated.
name(impl Into<String>)
/set_name(Option<String>)
:The updated rule name.
description(impl Into<String>)
/set_description(Option<String>)
:The updated rule description.
effect(MobileDeviceAccessRuleEffect)
/set_effect(Option<MobileDeviceAccessRuleEffect>)
:The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
.device_types(Vec<String>)
/set_device_types(Option<Vec<String>>)
:Device types that the updated rule will match.
not_device_types(Vec<String>)
/set_not_device_types(Option<Vec<String>>)
:Device types that the updated rule will not match. All other device types will match.
device_models(Vec<String>)
/set_device_models(Option<Vec<String>>)
:Device models that the updated rule will match.
not_device_models(Vec<String>)
/set_not_device_models(Option<Vec<String>>)
:Device models that the updated rule will not match. All other device models will match.
device_operating_systems(Vec<String>)
/set_device_operating_systems(Option<Vec<String>>)
:Device operating systems that the updated rule will match.
not_device_operating_systems(Vec<String>)
/set_not_device_operating_systems(Option<Vec<String>>)
:Device operating systems that the updated rule will not match. All other device operating systems will match.
device_user_agents(Vec<String>)
/set_device_user_agents(Option<Vec<String>>)
:User agents that the updated rule will match.
not_device_user_agents(Vec<String>)
/set_not_device_user_agents(Option<Vec<String>>)
:User agents that the updated rule will not match. All other user agents will match.
- On success, responds with
UpdateMobileDeviceAccessRuleOutput
- On failure, responds with
SdkError<UpdateMobileDeviceAccessRuleError>
sourcepub fn update_primary_email_address(&self) -> UpdatePrimaryEmailAddress
pub fn update_primary_email_address(&self) -> UpdatePrimaryEmailAddress
Constructs a fluent builder for the UpdatePrimaryEmailAddress
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The organization that contains the user, group, or resource to update.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:The user, group, or resource to update.
email(impl Into<String>)
/set_email(Option<String>)
:The value of the email to be updated as primary.
- On success, responds with
UpdatePrimaryEmailAddressOutput
- On failure, responds with
SdkError<UpdatePrimaryEmailAddressError>
sourcepub fn update_resource(&self) -> UpdateResource
pub fn update_resource(&self) -> UpdateResource
Constructs a fluent builder for the UpdateResource
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The identifier associated with the organization for which the resource is updated.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The identifier of the resource to be updated.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the resource to be updated.
booking_options(BookingOptions)
/set_booking_options(Option<BookingOptions>)
:The resource’s booking options to be updated.
- On success, responds with
UpdateResourceOutput
- On failure, responds with
SdkError<UpdateResourceError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more