workmail

package module
v1.25.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 42 Imported by: 15

Documentation

Overview

Package workmail provides the API client, operations, and parameter types for Amazon WorkMail.

WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored. The WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-10-01"
View Source 
const ServiceID = "WorkMail"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.19.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.22.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.22.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateDelegateToResourceInput 

type AssociateDelegateToResourceInput struct {

	// The member (user or group) to associate to the resource. The entity ID can
	// accept UserId or GroupID, Username or Groupname, or email.
	//   - Entity: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity: entity
	//
	// This member is required.
	EntityId *string

	// The organization under which the resource exists.
	//
	// This member is required.
	OrganizationId *string

	// The resource for which members (users or groups) are associated. The identifier
	// can accept ResourceId, Resourcename, or email. The following identity formats
	// are available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Email address: resource@domain.tld
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type AssociateDelegateToResourceOutput 

type AssociateDelegateToResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateMemberToGroupInput 

type AssociateMemberToGroupInput struct {

	// The group to which the member (user or group) is associated. The identifier can
	// accept GroupId, Groupname, or email. The following identity formats are
	// available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: group@domain.tld
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The member (user or group) to associate to the group. The member ID can accept
	// UserID or GroupId, Username or Groupname, or email.
	//   - Member: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: member@domain.tld
	//   - Member name: member
	//
	// This member is required.
	MemberId *string

	// The organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type AssociateMemberToGroupOutput 

type AssociateMemberToGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeImpersonationRoleInput added in v1.17.0 

type AssumeImpersonationRoleInput struct {

	// The impersonation role ID to assume.
	//
	// This member is required.
	ImpersonationRoleId *string

	// The WorkMail organization under which the impersonation role will be assumed.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type AssumeImpersonationRoleOutput added in v1.17.0 

type AssumeImpersonationRoleOutput struct {

	// The authentication token's validity, in seconds.
	ExpiresIn *int64

	// The authentication token for the impersonation role.
	Token *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.22.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.22.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelMailboxExportJobInput added in v0.29.0 

type CancelMailboxExportJobInput struct {

	// The idempotency token for the client request.
	//
	// This member is required.
	ClientToken *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type CancelMailboxExportJobOutput added in v0.29.0 

type CancelMailboxExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon WorkMail.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateDelegateToResource 

func (c *Client) AssociateDelegateToResource(ctx context.Context, params *AssociateDelegateToResourceInput, optFns ...func(*Options)) (*AssociateDelegateToResourceOutput, error)

Adds a member (user or group) to the resource's set of delegates.

func (*Client) AssociateMemberToGroup 

func (c *Client) AssociateMemberToGroup(ctx context.Context, params *AssociateMemberToGroupInput, optFns ...func(*Options)) (*AssociateMemberToGroupOutput, error)

Adds a member (user or group) to the group's set.

func (*Client) AssumeImpersonationRole added in v1.17.0 

func (c *Client) AssumeImpersonationRole(ctx context.Context, params *AssumeImpersonationRoleInput, optFns ...func(*Options)) (*AssumeImpersonationRoleOutput, error)

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

func (*Client) CancelMailboxExportJob added in v0.29.0 

func (c *Client) CancelMailboxExportJob(ctx context.Context, params *CancelMailboxExportJobInput, optFns ...func(*Options)) (*CancelMailboxExportJobOutput, error)

Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.

func (*Client) CreateAlias 

func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error)

Adds an alias to the set of a given member (user or group) of WorkMail.

func (*Client) CreateAvailabilityConfiguration added in v1.16.0 

func (c *Client) CreateAvailabilityConfiguration(ctx context.Context, params *CreateAvailabilityConfigurationInput, optFns ...func(*Options)) (*CreateAvailabilityConfigurationOutput, error)

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

func (*Client) CreateGroup 

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

func (*Client) CreateImpersonationRole added in v1.17.0 

func (c *Client) CreateImpersonationRole(ctx context.Context, params *CreateImpersonationRoleInput, optFns ...func(*Options)) (*CreateImpersonationRoleOutput, error)

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.

func (*Client) CreateMobileDeviceAccessRule added in v1.2.0 

func (c *Client) CreateMobileDeviceAccessRule(ctx context.Context, params *CreateMobileDeviceAccessRuleInput, optFns ...func(*Options)) (*CreateMobileDeviceAccessRuleOutput, error)

Creates a new mobile device access rule for the specified WorkMail organization.

func (*Client) CreateOrganization added in v0.29.0 

func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error)

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 (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html) 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 (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) and Choosing the default domain (https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html) 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.

func (*Client) CreateResource 

func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput, optFns ...func(*Options)) (*CreateResourceOutput, error)

Creates a new WorkMail resource.

func (*Client) CreateUser 

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

func (*Client) DeleteAccessControlRule added in v0.29.0 

func (c *Client) DeleteAccessControlRule(ctx context.Context, params *DeleteAccessControlRuleInput, optFns ...func(*Options)) (*DeleteAccessControlRuleOutput, error)

Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) DeleteAlias 

func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error)

Remove one or more specified aliases from a set of aliases for a given user.

func (*Client) DeleteAvailabilityConfiguration added in v1.16.0 

func (c *Client) DeleteAvailabilityConfiguration(ctx context.Context, params *DeleteAvailabilityConfigurationInput, optFns ...func(*Options)) (*DeleteAvailabilityConfigurationOutput, error)

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

func (*Client) DeleteEmailMonitoringConfiguration added in v1.11.0 

func (c *Client) DeleteEmailMonitoringConfiguration(ctx context.Context, params *DeleteEmailMonitoringConfigurationInput, optFns ...func(*Options)) (*DeleteEmailMonitoringConfigurationOutput, error)

Deletes the email monitoring configuration for a specified organization.

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group from WorkMail.

func (*Client) DeleteImpersonationRole added in v1.17.0 

func (c *Client) DeleteImpersonationRole(ctx context.Context, params *DeleteImpersonationRoleInput, optFns ...func(*Options)) (*DeleteImpersonationRoleOutput, error)

Deletes an impersonation role for the given WorkMail organization.

func (*Client) DeleteMailboxPermissions 

func (c *Client) DeleteMailboxPermissions(ctx context.Context, params *DeleteMailboxPermissionsInput, optFns ...func(*Options)) (*DeleteMailboxPermissionsOutput, error)

Deletes permissions granted to a member (user or group).

func (*Client) DeleteMobileDeviceAccessOverride added in v1.6.0 

func (c *Client) DeleteMobileDeviceAccessOverride(ctx context.Context, params *DeleteMobileDeviceAccessOverrideInput, optFns ...func(*Options)) (*DeleteMobileDeviceAccessOverrideOutput, error)

Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) DeleteMobileDeviceAccessRule added in v1.2.0 

func (c *Client) DeleteMobileDeviceAccessRule(ctx context.Context, params *DeleteMobileDeviceAccessRuleInput, optFns ...func(*Options)) (*DeleteMobileDeviceAccessRuleOutput, error)

Deletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) DeleteOrganization added in v0.29.0 

func (c *Client) DeleteOrganization(ctx context.Context, params *DeleteOrganizationInput, optFns ...func(*Options)) (*DeleteOrganizationOutput, error)

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 (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html) in the WorkMail Administrator Guide.

func (*Client) DeleteResource 

func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput, optFns ...func(*Options)) (*DeleteResourceOutput, error)

Deletes the specified resource.

func (*Client) DeleteRetentionPolicy added in v0.29.0 

func (c *Client) DeleteRetentionPolicy(ctx context.Context, params *DeleteRetentionPolicyInput, optFns ...func(*Options)) (*DeleteRetentionPolicyOutput, error)

Deletes the specified retention policy from the specified organization.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

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.

func (*Client) DeregisterFromWorkMail 

func (c *Client) DeregisterFromWorkMail(ctx context.Context, params *DeregisterFromWorkMailInput, optFns ...func(*Options)) (*DeregisterFromWorkMailOutput, error)

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.

func (*Client) DeregisterMailDomain added in v1.8.0 

func (c *Client) DeregisterMailDomain(ctx context.Context, params *DeregisterMailDomainInput, optFns ...func(*Options)) (*DeregisterMailDomainOutput, error)

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.

func (*Client) DescribeEmailMonitoringConfiguration added in v1.11.0 

func (c *Client) DescribeEmailMonitoringConfiguration(ctx context.Context, params *DescribeEmailMonitoringConfigurationInput, optFns ...func(*Options)) (*DescribeEmailMonitoringConfigurationOutput, error)

Describes the current email monitoring configuration for a specified organization.

func (*Client) DescribeEntity added in v1.20.0 

func (c *Client) DescribeEntity(ctx context.Context, params *DescribeEntityInput, optFns ...func(*Options)) (*DescribeEntityOutput, error)

Returns basic details about an entity in WorkMail.

func (*Client) DescribeGroup 

func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)

Returns the data available for the group.

func (*Client) DescribeInboundDmarcSettings added in v1.7.0 

func (c *Client) DescribeInboundDmarcSettings(ctx context.Context, params *DescribeInboundDmarcSettingsInput, optFns ...func(*Options)) (*DescribeInboundDmarcSettingsOutput, error)

Lists the settings in a DMARC policy for a specified organization.

func (*Client) DescribeMailboxExportJob added in v0.29.0 

func (c *Client) DescribeMailboxExportJob(ctx context.Context, params *DescribeMailboxExportJobInput, optFns ...func(*Options)) (*DescribeMailboxExportJobOutput, error)

Describes the current status of a mailbox export job.

func (*Client) DescribeOrganization 

func (c *Client) DescribeOrganization(ctx context.Context, params *DescribeOrganizationInput, optFns ...func(*Options)) (*DescribeOrganizationOutput, error)

Provides more information regarding a given organization based on its identifier.

func (*Client) DescribeResource 

func (c *Client) DescribeResource(ctx context.Context, params *DescribeResourceInput, optFns ...func(*Options)) (*DescribeResourceOutput, error)

Returns the data available for the resource.

func (*Client) DescribeUser 

func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)

Provides information regarding the user.

func (*Client) DisassociateDelegateFromResource 

func (c *Client) DisassociateDelegateFromResource(ctx context.Context, params *DisassociateDelegateFromResourceInput, optFns ...func(*Options)) (*DisassociateDelegateFromResourceOutput, error)

Removes a member from the resource's set of delegates.

func (*Client) DisassociateMemberFromGroup 

func (c *Client) DisassociateMemberFromGroup(ctx context.Context, params *DisassociateMemberFromGroupInput, optFns ...func(*Options)) (*DisassociateMemberFromGroupOutput, error)

Removes a member from a group.

func (*Client) GetAccessControlEffect added in v0.29.0 

func (c *Client) GetAccessControlEffect(ctx context.Context, params *GetAccessControlEffectInput, optFns ...func(*Options)) (*GetAccessControlEffectOutput, error)

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.

func (*Client) GetDefaultRetentionPolicy added in v0.29.0 

func (c *Client) GetDefaultRetentionPolicy(ctx context.Context, params *GetDefaultRetentionPolicyInput, optFns ...func(*Options)) (*GetDefaultRetentionPolicyOutput, error)

Gets the default retention policy details for the specified organization.

func (*Client) GetImpersonationRole added in v1.17.0 

func (c *Client) GetImpersonationRole(ctx context.Context, params *GetImpersonationRoleInput, optFns ...func(*Options)) (*GetImpersonationRoleOutput, error)

Gets the impersonation role details for the given WorkMail organization.

func (*Client) GetImpersonationRoleEffect added in v1.17.0 

func (c *Client) GetImpersonationRoleEffect(ctx context.Context, params *GetImpersonationRoleEffectInput, optFns ...func(*Options)) (*GetImpersonationRoleEffectOutput, error)

Tests whether the given impersonation role can impersonate a target user.

func (*Client) GetMailDomain added in v1.8.0 

func (c *Client) GetMailDomain(ctx context.Context, params *GetMailDomainInput, optFns ...func(*Options)) (*GetMailDomainOutput, error)

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

func (*Client) GetMailboxDetails 

func (c *Client) GetMailboxDetails(ctx context.Context, params *GetMailboxDetailsInput, optFns ...func(*Options)) (*GetMailboxDetailsOutput, error)

Requests a user's mailbox details for a specified organization and user.

func (*Client) GetMobileDeviceAccessEffect added in v1.2.0 

func (c *Client) GetMobileDeviceAccessEffect(ctx context.Context, params *GetMobileDeviceAccessEffectInput, optFns ...func(*Options)) (*GetMobileDeviceAccessEffectOutput, error)

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.

func (*Client) GetMobileDeviceAccessOverride added in v1.6.0 

func (c *Client) GetMobileDeviceAccessOverride(ctx context.Context, params *GetMobileDeviceAccessOverrideInput, optFns ...func(*Options)) (*GetMobileDeviceAccessOverrideOutput, error)

Gets the mobile device access override for the given WorkMail organization, user, and device.

func (*Client) ListAccessControlRules added in v0.29.0 

func (c *Client) ListAccessControlRules(ctx context.Context, params *ListAccessControlRulesInput, optFns ...func(*Options)) (*ListAccessControlRulesOutput, error)

Lists the access control rules for the specified organization.

func (*Client) ListAliases 

func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error)

Creates a paginated call to list the aliases associated with a given entity.

func (*Client) ListAvailabilityConfigurations added in v1.16.0 

func (c *Client) ListAvailabilityConfigurations(ctx context.Context, params *ListAvailabilityConfigurationsInput, optFns ...func(*Options)) (*ListAvailabilityConfigurationsOutput, error)

List all the AvailabilityConfiguration 's for the given WorkMail organization.

func (*Client) ListGroupMembers 

func (c *Client) ListGroupMembers(ctx context.Context, params *ListGroupMembersInput, optFns ...func(*Options)) (*ListGroupMembersOutput, error)

Returns an overview of the members of a group. Users and groups can be members of a group.

func (*Client) ListGroups 

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Returns summaries of the organization's groups.

func (*Client) ListGroupsForEntity added in v1.20.0 

func (c *Client) ListGroupsForEntity(ctx context.Context, params *ListGroupsForEntityInput, optFns ...func(*Options)) (*ListGroupsForEntityOutput, error)

Returns all the groups to which an entity belongs.

func (*Client) ListImpersonationRoles added in v1.17.0 

func (c *Client) ListImpersonationRoles(ctx context.Context, params *ListImpersonationRolesInput, optFns ...func(*Options)) (*ListImpersonationRolesOutput, error)

Lists all the impersonation roles for the given WorkMail organization.

func (*Client) ListMailDomains added in v1.8.0 

func (c *Client) ListMailDomains(ctx context.Context, params *ListMailDomainsInput, optFns ...func(*Options)) (*ListMailDomainsOutput, error)

Lists the mail domains in a given WorkMail organization.

func (*Client) ListMailboxExportJobs added in v0.29.0 

func (c *Client) ListMailboxExportJobs(ctx context.Context, params *ListMailboxExportJobsInput, optFns ...func(*Options)) (*ListMailboxExportJobsOutput, error)

Lists the mailbox export jobs started for the specified organization within the last seven days.

func (*Client) ListMailboxPermissions 

func (c *Client) ListMailboxPermissions(ctx context.Context, params *ListMailboxPermissionsInput, optFns ...func(*Options)) (*ListMailboxPermissionsOutput, error)

Lists the mailbox permissions associated with a user, group, or resource mailbox.

func (*Client) ListMobileDeviceAccessOverrides added in v1.6.0 

func (c *Client) ListMobileDeviceAccessOverrides(ctx context.Context, params *ListMobileDeviceAccessOverridesInput, optFns ...func(*Options)) (*ListMobileDeviceAccessOverridesOutput, error)

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

func (*Client) ListMobileDeviceAccessRules added in v1.2.0 

func (c *Client) ListMobileDeviceAccessRules(ctx context.Context, params *ListMobileDeviceAccessRulesInput, optFns ...func(*Options)) (*ListMobileDeviceAccessRulesOutput, error)

Lists the mobile device access rules for the specified WorkMail organization.

func (*Client) ListOrganizations 

func (c *Client) ListOrganizations(ctx context.Context, params *ListOrganizationsInput, optFns ...func(*Options)) (*ListOrganizationsOutput, error)

Returns summaries of the customer's organizations.

func (*Client) ListResourceDelegates 

func (c *Client) ListResourceDelegates(ctx context.Context, params *ListResourceDelegatesInput, optFns ...func(*Options)) (*ListResourceDelegatesOutput, error)

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

func (*Client) ListResources 

func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)

Returns summaries of the organization's resources.

func (*Client) ListTagsForResource added in v0.29.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags applied to an WorkMail organization resource.

func (*Client) ListUsers 

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Returns summaries of the organization's users.

func (*Client) Options added in v1.23.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutAccessControlRule added in v0.29.0 

func (c *Client) PutAccessControlRule(ctx context.Context, params *PutAccessControlRuleInput, optFns ...func(*Options)) (*PutAccessControlRuleOutput, error)

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.

func (*Client) PutEmailMonitoringConfiguration added in v1.11.0 

func (c *Client) PutEmailMonitoringConfiguration(ctx context.Context, params *PutEmailMonitoringConfigurationInput, optFns ...func(*Options)) (*PutEmailMonitoringConfigurationOutput, error)

Creates or updates the email monitoring configuration for a specified organization.

func (*Client) PutInboundDmarcSettings added in v1.7.0 

func (c *Client) PutInboundDmarcSettings(ctx context.Context, params *PutInboundDmarcSettingsInput, optFns ...func(*Options)) (*PutInboundDmarcSettingsOutput, error)

Enables or disables a DMARC policy for a given organization.

func (*Client) PutMailboxPermissions 

func (c *Client) PutMailboxPermissions(ctx context.Context, params *PutMailboxPermissionsInput, optFns ...func(*Options)) (*PutMailboxPermissionsOutput, error)

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

func (*Client) PutMobileDeviceAccessOverride added in v1.6.0 

func (c *Client) PutMobileDeviceAccessOverride(ctx context.Context, params *PutMobileDeviceAccessOverrideInput, optFns ...func(*Options)) (*PutMobileDeviceAccessOverrideOutput, error)

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

func (*Client) PutRetentionPolicy added in v0.29.0 

func (c *Client) PutRetentionPolicy(ctx context.Context, params *PutRetentionPolicyInput, optFns ...func(*Options)) (*PutRetentionPolicyOutput, error)

Puts a retention policy to the specified organization.

func (*Client) RegisterMailDomain added in v1.8.0 

func (c *Client) RegisterMailDomain(ctx context.Context, params *RegisterMailDomainInput, optFns ...func(*Options)) (*RegisterMailDomainOutput, error)

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.

func (*Client) RegisterToWorkMail 

func (c *Client) RegisterToWorkMail(ctx context.Context, params *RegisterToWorkMailInput, optFns ...func(*Options)) (*RegisterToWorkMailOutput, error)

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 (https://aws.amazon.com/workmail/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 .

func (*Client) ResetPassword 

func (c *Client) ResetPassword(ctx context.Context, params *ResetPasswordInput, optFns ...func(*Options)) (*ResetPasswordOutput, error)

Allows the administrator to reset the password for a user.

func (*Client) StartMailboxExportJob added in v0.29.0 

func (c *Client) StartMailboxExportJob(ctx context.Context, params *StartMailboxExportJobInput, optFns ...func(*Options)) (*StartMailboxExportJobOutput, error)

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 (https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html) in the WorkMail Administrator Guide.

func (*Client) TagResource added in v0.29.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Applies the specified tags to the specified WorkMailorganization resource.

func (*Client) TestAvailabilityConfiguration added in v1.16.0 

func (c *Client) TestAvailabilityConfiguration(ctx context.Context, params *TestAvailabilityConfigurationInput, optFns ...func(*Options)) (*TestAvailabilityConfigurationOutput, error)

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. The request must contain either one provider definition ( EwsProvider or LambdaProvider ) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

func (*Client) UntagResource added in v0.29.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untags the specified tags from the specified WorkMail organization resource.

func (*Client) UpdateAvailabilityConfiguration added in v1.16.0 

func (c *Client) UpdateAvailabilityConfiguration(ctx context.Context, params *UpdateAvailabilityConfigurationInput, optFns ...func(*Options)) (*UpdateAvailabilityConfigurationOutput, error)

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

func (*Client) UpdateDefaultMailDomain added in v1.8.0 

func (c *Client) UpdateDefaultMailDomain(ctx context.Context, params *UpdateDefaultMailDomainInput, optFns ...func(*Options)) (*UpdateDefaultMailDomainOutput, error)

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.

func (*Client) UpdateGroup added in v1.20.0 

func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

Updates attibutes in a group.

func (*Client) UpdateImpersonationRole added in v1.17.0 

func (c *Client) UpdateImpersonationRole(ctx context.Context, params *UpdateImpersonationRoleInput, optFns ...func(*Options)) (*UpdateImpersonationRoleOutput, error)

Updates an impersonation role for the given WorkMail organization.

func (*Client) UpdateMailboxQuota 

func (c *Client) UpdateMailboxQuota(ctx context.Context, params *UpdateMailboxQuotaInput, optFns ...func(*Options)) (*UpdateMailboxQuotaOutput, error)

Updates a user's current mailbox quota for a specified organization and user.

func (*Client) UpdateMobileDeviceAccessRule added in v1.2.0 

func (c *Client) UpdateMobileDeviceAccessRule(ctx context.Context, params *UpdateMobileDeviceAccessRuleInput, optFns ...func(*Options)) (*UpdateMobileDeviceAccessRuleOutput, error)

Updates a mobile device access rule for the specified WorkMail organization.

func (*Client) UpdatePrimaryEmailAddress 

func (c *Client) UpdatePrimaryEmailAddress(ctx context.Context, params *UpdatePrimaryEmailAddressInput, optFns ...func(*Options)) (*UpdatePrimaryEmailAddressOutput, error)

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.

func (*Client) UpdateResource 

func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error)

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.

func (*Client) UpdateUser added in v1.20.0 

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

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.

type CreateAliasInput 

type CreateAliasInput struct {

	// The alias to add to the member set.
	//
	// This member is required.
	Alias *string

	// The member (user or group) to which this alias is added.
	//
	// This member is required.
	EntityId *string

	// The organization under which the member (user or group) exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type CreateAliasOutput 

type CreateAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAvailabilityConfigurationInput added in v1.16.0 

type CreateAvailabilityConfigurationInput struct {

	// The domain to which the provider applies.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which the AvailabilityConfiguration will be
	// created.
	//
	// This member is required.
	OrganizationId *string

	// An idempotent token that ensures that an API request is executed only once.
	ClientToken *string

	// Exchange Web Services (EWS) availability provider definition. The request must
	// contain exactly one provider definition, either EwsProvider or LambdaProvider .
	EwsProvider *types.EwsAvailabilityProvider

	// Lambda availability provider definition. The request must contain exactly one
	// provider definition, either EwsProvider or LambdaProvider .
	LambdaProvider *types.LambdaAvailabilityProvider
	// contains filtered or unexported fields
}

type CreateAvailabilityConfigurationOutput added in v1.16.0 

type CreateAvailabilityConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGroupInput 

type CreateGroupInput struct {

	// The name of the group.
	//
	// This member is required.
	Name *string

	// The organization under which the group is to be created.
	//
	// This member is required.
	OrganizationId *string

	// If this parameter is enabled, the group will be hidden from the address book.
	HiddenFromGlobalAddressList bool
	// contains filtered or unexported fields
}

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The identifier of the group.
	GroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateImpersonationRoleInput added in v1.17.0 

type CreateImpersonationRoleInput struct {

	// The name of the new impersonation role.
	//
	// This member is required.
	Name *string

	// The WorkMail organization to create the new impersonation role within.
	//
	// This member is required.
	OrganizationId *string

	// The list of rules for the impersonation role.
	//
	// This member is required.
	Rules []types.ImpersonationRule

	// The impersonation role's type. The available impersonation role types are
	// READ_ONLY or FULL_ACCESS .
	//
	// This member is required.
	Type types.ImpersonationRoleType

	// The idempotency token for the client request.
	ClientToken *string

	// The description of the new impersonation role.
	Description *string
	// contains filtered or unexported fields
}

type CreateImpersonationRoleOutput added in v1.17.0 

type CreateImpersonationRoleOutput struct {

	// The new impersonation role ID.
	ImpersonationRoleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMobileDeviceAccessRuleInput added in v1.2.0 

type CreateMobileDeviceAccessRuleInput struct {

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY .
	//
	// This member is required.
	Effect types.MobileDeviceAccessRuleEffect

	// The rule name.
	//
	// This member is required.
	Name *string

	// The WorkMail organization under which the rule will be created.
	//
	// This member is required.
	OrganizationId *string

	// The idempotency token for the client request.
	ClientToken *string

	// The rule description.
	Description *string

	// Device models that the rule will match.
	DeviceModels []string

	// Device operating systems that the rule will match.
	DeviceOperatingSystems []string

	// Device types that the rule will match.
	DeviceTypes []string

	// Device user agents that the rule will match.
	DeviceUserAgents []string

	// Device models that the rule will not match. All other device models will match.
	NotDeviceModels []string

	// Device operating systems that the rule will not match. All other device
	// operating systems will match.
	NotDeviceOperatingSystems []string

	// Device types that the rule will not match. All other device types will match.
	NotDeviceTypes []string

	// Device user agents that the rule will not match. All other device user agents
	// will match.
	NotDeviceUserAgents []string
	// contains filtered or unexported fields
}

type CreateMobileDeviceAccessRuleOutput added in v1.2.0 

type CreateMobileDeviceAccessRuleOutput struct {

	// The identifier for the newly created mobile device access rule.
	MobileDeviceAccessRuleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateOrganizationInput added in v0.29.0 

type CreateOrganizationInput struct {

	// The organization alias.
	//
	// This member is required.
	Alias *string

	// The idempotency token associated with the request.
	ClientToken *string

	// The AWS Directory Service directory ID.
	DirectoryId *string

	// The email domains to associate with the organization.
	Domains []types.Domain

	// When true , allows organization interoperability between WorkMail and Microsoft
	// Exchange. If true , you must include a AD Connector directory ID in the request.
	EnableInteroperability bool

	// The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

type CreateOrganizationOutput added in v0.29.0 

type CreateOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateResourceInput 

type CreateResourceInput struct {

	// The name of the new resource.
	//
	// This member is required.
	Name *string

	// The identifier associated with the organization for which the resource is
	// created.
	//
	// This member is required.
	OrganizationId *string

	// The type of the new resource. The available types are equipment and room .
	//
	// This member is required.
	Type types.ResourceType

	// Resource description.
	Description *string

	// If this parameter is enabled, the resource will be hidden from the address book.
	HiddenFromGlobalAddressList bool
	// contains filtered or unexported fields
}

type CreateResourceOutput 

type CreateResourceOutput struct {

	// The identifier of the new resource.
	ResourceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUserInput 

type CreateUserInput struct {

	// The display name for the new user.
	//
	// This member is required.
	DisplayName *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.
	//
	// This member is required.
	Name *string

	// The identifier of the organization for which the user is created.
	//
	// This member is required.
	OrganizationId *string

	// The first name of the new user.
	FirstName *string

	// If this parameter is enabled, the user will be hidden from the address book.
	HiddenFromGlobalAddressList bool

	// The last name of the new user.
	LastName *string

	// The password for the new user.
	Password *string

	// The role of the new user. You cannot pass SYSTEM_USER or RESOURCE role in a
	// single request. When a user role is not selected, the default role of USER is
	// selected.
	Role types.UserRole
	// contains filtered or unexported fields
}

type CreateUserOutput 

type CreateUserOutput struct {

	// The identifier for the new user.
	UserId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccessControlRuleInput added in v0.29.0 

type DeleteAccessControlRuleInput struct {

	// The name of the access control rule.
	//
	// This member is required.
	Name *string

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteAccessControlRuleOutput added in v0.29.0 

type DeleteAccessControlRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAliasInput 

type DeleteAliasInput struct {

	// 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).
	//
	// This member is required.
	Alias *string

	// The identifier for the member (user or group) from which to have the aliases
	// removed.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the user exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteAliasOutput 

type DeleteAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAvailabilityConfigurationInput added in v1.16.0 

type DeleteAvailabilityConfigurationInput struct {

	// The domain for which the AvailabilityConfiguration will be deleted.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which the AvailabilityConfiguration will be
	// deleted.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteAvailabilityConfigurationOutput added in v1.16.0 

type DeleteAvailabilityConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEmailMonitoringConfigurationInput added in v1.11.0 

type DeleteEmailMonitoringConfigurationInput struct {

	// The ID of the organization from which the email monitoring configuration is
	// deleted.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteEmailMonitoringConfigurationOutput added in v1.11.0 

type DeleteEmailMonitoringConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The identifier of the group to be deleted. The identifier can be the GroupId,
	// or Groupname. The following identity formats are available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The organization that contains the group.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteGroupOutput 

type DeleteGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImpersonationRoleInput added in v1.17.0 

type DeleteImpersonationRoleInput struct {

	// The ID of the impersonation role to delete.
	//
	// This member is required.
	ImpersonationRoleId *string

	// The WorkMail organization from which to delete the impersonation role.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteImpersonationRoleOutput added in v1.17.0 

type DeleteImpersonationRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMailboxPermissionsInput 

type DeleteMailboxPermissionsInput struct {

	// The identifier of the entity that owns the mailbox. The identifier can be
	// UserId or Group Id, Username or Groupname, or email.
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier of the entity for which to delete granted permissions. The
	// identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or
	// email.
	//   - Grantee ID:
	//   12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: grantee@domain.tld
	//   - Grantee name: grantee
	//
	// This member is required.
	GranteeId *string

	// The identifier of the organization under which the member (user or group)
	// exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteMailboxPermissionsOutput 

type DeleteMailboxPermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMobileDeviceAccessOverrideInput added in v1.6.0 

type DeleteMobileDeviceAccessOverrideInput struct {

	// The mobile device for which you delete the override. DeviceId is case
	// insensitive.
	//
	// This member is required.
	DeviceId *string

	// The WorkMail organization for which the access override will be deleted.
	//
	// This member is required.
	OrganizationId *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 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteMobileDeviceAccessOverrideOutput added in v1.6.0 

type DeleteMobileDeviceAccessOverrideOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMobileDeviceAccessRuleInput added in v1.2.0 

type DeleteMobileDeviceAccessRuleInput struct {

	// The identifier of the rule to be deleted.
	//
	// This member is required.
	MobileDeviceAccessRuleId *string

	// The WorkMail organization under which the rule will be deleted.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteMobileDeviceAccessRuleOutput added in v1.2.0 

type DeleteMobileDeviceAccessRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteOrganizationInput added in v0.29.0 

type DeleteOrganizationInput struct {

	// If true, deletes the AWS Directory Service directory associated with the
	// organization.
	//
	// This member is required.
	DeleteDirectory bool

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string

	// The idempotency token associated with the request.
	ClientToken *string

	// Deletes a WorkMail organization even if the organization has enabled users.
	ForceDelete bool
	// contains filtered or unexported fields
}

type DeleteOrganizationOutput added in v0.29.0 

type DeleteOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string

	// The state of the organization.
	State *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourceInput 

type DeleteResourceInput struct {

	// The identifier associated with the organization from which the resource is
	// deleted.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be deleted. The identifier can accept
	// ResourceId, or Resourcename. The following identity formats are available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DeleteResourceOutput 

type DeleteResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRetentionPolicyInput added in v0.29.0 

type DeleteRetentionPolicyInput struct {

	// The retention policy ID.
	//
	// This member is required.
	Id *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeleteRetentionPolicyOutput added in v0.29.0 

type DeleteRetentionPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUserInput 

type DeleteUserInput struct {

	// The organization that contains the user to be deleted.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the user to be deleted. The identifier can be the UserId or
	// Username. The following identity formats are available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteUserOutput 

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterFromWorkMailInput 

type DeregisterFromWorkMailInput struct {

	// The identifier for the member to be updated. The identifier can be UserId,
	// ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the WorkMail entity exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeregisterFromWorkMailOutput 

type DeregisterFromWorkMailOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterMailDomainInput added in v1.8.0 

type DeregisterMailDomainInput struct {

	// The domain to deregister in WorkMail and SES.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which the domain will be deregistered.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DeregisterMailDomainOutput added in v1.8.0 

type DeregisterMailDomainOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEmailMonitoringConfigurationInput added in v1.11.0 

type DescribeEmailMonitoringConfigurationInput struct {

	// The ID of the organization for which the email monitoring configuration is
	// described.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeEmailMonitoringConfigurationOutput added in v1.11.0 

type DescribeEmailMonitoringConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the
	// email monitoring configuration.
	LogGroupArn *string

	// The Amazon Resource Name (ARN) of the IAM Role associated with the email
	// monitoring configuration.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEntityInput added in v1.20.0 

type DescribeEntityInput struct {

	// The email under which the entity exists.
	//
	// This member is required.
	Email *string

	// The identifier for the organization under which the entity exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeEntityOutput added in v1.20.0 

type DescribeEntityOutput struct {

	// The entity ID under which the entity exists.
	EntityId *string

	// Username, GroupName, or ResourceName based on entity type.
	Name *string

	// Entity type.
	Type types.EntityType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeGroupInput 

type DescribeGroupInput struct {

	// The identifier for the group to be described. The identifier can accept
	// GroupId, Groupname, or email. The following identity formats are available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: group@domain.tld
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeGroupOutput 

type DescribeGroupOutput struct {

	// The date and time when a user was deregistered from WorkMail, in UNIX epoch
	// time format.
	DisabledDate *time.Time

	// The email of the described group.
	Email *string

	// The date and time when a user was registered to WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time

	// The identifier of the described group.
	GroupId *string

	// If the value is set to true, the group is hidden from the address book.
	HiddenFromGlobalAddressList bool

	// The name of the described group.
	Name *string

	// The state of the user: enabled (registered to WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State types.EntityState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeInboundDmarcSettingsInput added in v1.7.0 

type DescribeInboundDmarcSettingsInput struct {

	// Lists the ID of the given organization.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeInboundDmarcSettingsOutput added in v1.7.0 

type DescribeInboundDmarcSettingsOutput struct {

	// Lists the enforcement setting of the applied policy.
	Enforced bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeMailboxExportJobInput added in v0.29.0 

type DescribeMailboxExportJobInput struct {

	// The mailbox export job ID.
	//
	// This member is required.
	JobId *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeMailboxExportJobOutput added in v0.29.0 

type DescribeMailboxExportJobOutput struct {

	// The mailbox export job description.
	Description *string

	// The mailbox export job end timestamp.
	EndTime *time.Time

	// The identifier of the user or resource associated with the mailbox.
	EntityId *string

	// Error information for failed mailbox export jobs.
	ErrorInfo *string

	// The estimated progress of the mailbox export job, in percentage points.
	EstimatedProgress int32

	// The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS
	// KMS) key that encrypts the exported mailbox content.
	KmsKeyArn *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.
	RoleArn *string

	// The name of the S3 bucket.
	S3BucketName *string

	// The path to the S3 bucket and file that the mailbox export job is exporting to.
	S3Path *string

	// The S3 bucket prefix.
	S3Prefix *string

	// The mailbox export job start timestamp.
	StartTime *time.Time

	// The state of the mailbox export job.
	State types.MailboxExportJobState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeOrganizationInput 

type DescribeOrganizationInput struct {

	// The identifier for the organization to be described.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DescribeOrganizationOutput 

type DescribeOrganizationOutput struct {

	// The Amazon Resource Name (ARN) of the organization.
	ARN *string

	// The alias for an organization.
	Alias *string

	// The date at which the organization became usable in the WorkMail context, in
	// UNIX epoch time format.
	CompletedDate *time.Time

	// The default mail domain associated with the organization.
	DefaultMailDomain *string

	// The identifier for the directory associated with an WorkMail organization.
	DirectoryId *string

	// The type of directory associated with the WorkMail organization.
	DirectoryType *string

	// (Optional) The error message indicating if unexpected behavior was encountered
	// with regards to the organization.
	ErrorMessage *string

	// Indicates if interoperability is enabled for this organization.
	InteroperabilityEnabled bool

	// The user ID of the migration admin if migration is enabled for the organization.
	MigrationAdmin *string

	// The identifier of an organization.
	OrganizationId *string

	// The state of an organization.
	State *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeResourceInput 

type DescribeResourceInput struct {

	// The identifier associated with the organization for which the resource is
	// described.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be described. The identifier can accept
	// ResourceId, Resourcename, or email. The following identity formats are
	// available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Email address: resource@domain.tld
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DescribeResourceOutput 

type DescribeResourceOutput struct {

	// The booking options for the described resource.
	BookingOptions *types.BookingOptions

	// Description of the resource.
	Description *string

	// The date and time when a resource was disabled from WorkMail, in UNIX epoch
	// time format.
	DisabledDate *time.Time

	// The email of the described resource.
	Email *string

	// The date and time when a resource was enabled for WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time

	// If enabled, the resource is hidden from the global address list.
	HiddenFromGlobalAddressList bool

	// The name of the described resource.
	Name *string

	// The identifier of the described resource.
	ResourceId *string

	// The state of the resource: enabled (registered to WorkMail), disabled
	// (deregistered or never registered to WorkMail), or deleted.
	State types.EntityState

	// The type of the described resource.
	Type types.ResourceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeUserInput 

type DescribeUserInput struct {

	// The identifier for the organization under which the user exists.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the user to be described. The identifier can be the UserId,
	// Username, or email. The following identity formats are available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DescribeUserOutput 

type DescribeUserOutput struct {

	// City where the user is located.
	City *string

	// Company of the user.
	Company *string

	// Country where the user is located.
	Country *string

	// Department of the user.
	Department *string

	// The date and time at which the user was disabled for WorkMail usage, in UNIX
	// epoch time format.
	DisabledDate *time.Time

	// The display name of the user.
	DisplayName *string

	// The email of the user.
	Email *string

	// The date and time at which the user was enabled for WorkMailusage, in UNIX
	// epoch time format.
	EnabledDate *time.Time

	// First name of the user.
	FirstName *string

	// If enabled, the user is hidden from the global address list.
	HiddenFromGlobalAddressList bool

	// Initials of the user.
	Initials *string

	// Job title of the user.
	JobTitle *string

	// Last name of the user.
	LastName *string

	// The date when the mailbox was removed for the user.
	MailboxDeprovisionedDate *time.Time

	// The date when the mailbox was created for the user.
	MailboxProvisionedDate *time.Time

	// The name for the user.
	Name *string

	// Office where the user is located.
	Office *string

	// The state of a user: enabled (registered to WorkMail) or disabled (deregistered
	// or never registered to WorkMail).
	State types.EntityState

	// Street where the user is located.
	Street *string

	// User's contact number.
	Telephone *string

	// The identifier for the described user.
	UserId *string

	// In certain cases, other entities are modeled as users. If interoperability is
	// enabled, resources are imported into 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,
	// SYSTEM_USER, and REMOTE_USER.
	UserRole types.UserRole

	// Zip code of the user.
	ZipCode *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateDelegateFromResourceInput 

type DisassociateDelegateFromResourceInput struct {

	// The identifier for the member (user, group) to be removed from the resource's
	// delegates. The entity ID can accept UserId or GroupID, Username or Groupname, or
	// email.
	//   - Entity: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity: entity
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the resource exists.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource from which delegates' set members are removed.
	// The identifier can accept ResourceId, Resourcename, or email. The following
	// identity formats are available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Email address: resource@domain.tld
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DisassociateDelegateFromResourceOutput 

type DisassociateDelegateFromResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberFromGroupInput 

type DisassociateMemberFromGroupInput struct {

	// The identifier for the group from which members are removed. The identifier can
	// accept GroupId, Groupname, or email. The following identity formats are
	// available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: group@domain.tld
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The identifier for the member to be removed from the group. The member ID can
	// accept UserID or GroupId, Username or Groupname, or email.
	//   - Member ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: member@domain.tld
	//   - Member name: member
	//
	// This member is required.
	MemberId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type DisassociateMemberFromGroupOutput 

type DisassociateMemberFromGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.19.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.19.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.19.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.19.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccessControlEffectInput added in v0.29.0 

type GetAccessControlEffectInput struct {

	// The access protocol action. Valid values include ActiveSync , AutoDiscover , EWS
	// , IMAP , SMTP , WindowsOutlook , and WebMail .
	//
	// This member is required.
	Action *string

	// The IPv4 address.
	//
	// This member is required.
	IpAddress *string

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string

	// The impersonation role ID.
	ImpersonationRoleId *string

	// The user ID.
	UserId *string
	// contains filtered or unexported fields
}

type GetAccessControlEffectOutput added in v0.29.0 

type GetAccessControlEffectOutput struct {

	// The rule effect.
	Effect types.AccessControlRuleEffect

	// The rules that match the given parameters, resulting in an effect.
	MatchedRules []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDefaultRetentionPolicyInput added in v0.29.0 

type GetDefaultRetentionPolicyInput struct {

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type GetDefaultRetentionPolicyOutput added in v0.29.0 

type GetDefaultRetentionPolicyOutput struct {

	// The retention policy description.
	Description *string

	// The retention policy folder configurations.
	FolderConfigurations []types.FolderConfiguration

	// The retention policy ID.
	Id *string

	// The retention policy name.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImpersonationRoleEffectInput added in v1.17.0 

type GetImpersonationRoleEffectInput struct {

	// The impersonation role ID to test.
	//
	// This member is required.
	ImpersonationRoleId *string

	// The WorkMail organization where the impersonation role is defined.
	//
	// This member is required.
	OrganizationId *string

	// The WorkMail organization user chosen to test the impersonation role. The
	// following identity formats are available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	TargetUser *string
	// contains filtered or unexported fields
}

type GetImpersonationRoleEffectOutput added in v1.17.0 

type GetImpersonationRoleEffectOutput struct {

	// Effect of the impersonation role on the target user based on its rules.
	// Available effects are ALLOW or DENY .
	Effect types.AccessEffect

	// A list of the rules that match the input and produce the configured effect.
	MatchedRules []types.ImpersonationMatchedRule

	// The impersonation role type.
	Type types.ImpersonationRoleType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImpersonationRoleInput added in v1.17.0 

type GetImpersonationRoleInput struct {

	// The impersonation role ID to retrieve.
	//
	// This member is required.
	ImpersonationRoleId *string

	// The WorkMail organization from which to retrieve the impersonation role.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type GetImpersonationRoleOutput added in v1.17.0 

type GetImpersonationRoleOutput struct {

	// The date when the impersonation role was created.
	DateCreated *time.Time

	// The date when the impersonation role was last modified.
	DateModified *time.Time

	// The impersonation role description.
	Description *string

	// The impersonation role ID.
	ImpersonationRoleId *string

	// The impersonation role name.
	Name *string

	// The list of rules for the given impersonation role.
	Rules []types.ImpersonationRule

	// The impersonation role type.
	Type types.ImpersonationRoleType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMailDomainInput added in v1.8.0 

type GetMailDomainInput struct {

	// The domain from which you want to retrieve details.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which the domain is retrieved.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type GetMailDomainOutput added in v1.8.0 

type GetMailDomainOutput struct {

	// Indicates the status of a DKIM verification.
	DkimVerificationStatus types.DnsRecordVerificationStatus

	// Specifies whether the domain is the default domain for your organization.
	IsDefault bool

	// Specifies whether the domain is a test domain provided by WorkMail, or a custom
	// domain.
	IsTestDomain bool

	// Indicates the status of the domain ownership verification.
	OwnershipVerificationStatus types.DnsRecordVerificationStatus

	// A list of the DNS records that 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.
	Records []types.DnsRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMailboxDetailsInput 

type GetMailboxDetailsInput struct {

	// The identifier for the organization that contains the user whose mailbox
	// details are being requested.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the user whose mailbox details are being requested. The
	// identifier can be the UserId, Username, or email. The following identity formats
	// are available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type GetMailboxDetailsOutput 

type GetMailboxDetailsOutput struct {

	// The maximum allowed mailbox size, in MB, for the specified user.
	MailboxQuota *int32

	// The current mailbox size, in MB, for the specified user.
	MailboxSize float64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMobileDeviceAccessEffectInput added in v1.2.0 

type GetMobileDeviceAccessEffectInput struct {

	// The WorkMail organization to simulate the access effect for.
	//
	// This member is required.
	OrganizationId *string

	// Device model the simulated user will report.
	DeviceModel *string

	// Device operating system the simulated user will report.
	DeviceOperatingSystem *string

	// Device type the simulated user will report.
	DeviceType *string

	// Device user agent the simulated user will report.
	DeviceUserAgent *string
	// contains filtered or unexported fields
}

type GetMobileDeviceAccessEffectOutput added in v1.2.0 

type GetMobileDeviceAccessEffectOutput struct {

	// The effect of the simulated access, ALLOW or DENY , after evaluating mobile
	// device access rules in the WorkMail organization for the simulated user
	// parameters.
	Effect types.MobileDeviceAccessRuleEffect

	// A list of the rules which matched the simulated user input and produced the
	// effect.
	MatchedRules []types.MobileDeviceAccessMatchedRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMobileDeviceAccessOverrideInput added in v1.6.0 

type GetMobileDeviceAccessOverrideInput struct {

	// The mobile device to which the override applies. DeviceId is case insensitive.
	//
	// This member is required.
	DeviceId *string

	// The WorkMail organization to which you want to apply the override.
	//
	// This member is required.
	OrganizationId *string

	// Identifies the WorkMail user for the override. Accepts the following types of
	// user identities:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type GetMobileDeviceAccessOverrideOutput added in v1.6.0 

type GetMobileDeviceAccessOverrideOutput struct {

	// The date the override was first created.
	DateCreated *time.Time

	// The date the description was last modified.
	DateModified *time.Time

	// A description of the override.
	Description *string

	// The device to which the access override applies.
	DeviceId *string

	// The effect of the override, ALLOW or DENY .
	Effect types.MobileDeviceAccessRuleEffect

	// The WorkMail user to which the access override applies.
	UserId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider added in v0.29.0 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccessControlRulesInput added in v0.29.0 

type ListAccessControlRulesInput struct {

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type ListAccessControlRulesOutput added in v0.29.0 

type ListAccessControlRulesOutput struct {

	// The access control rules.
	Rules []types.AccessControlRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAliasesAPIClient added in v0.30.0 

type ListAliasesAPIClient interface {
	ListAliases(context.Context, *ListAliasesInput, ...func(*Options)) (*ListAliasesOutput, error)
}

ListAliasesAPIClient is a client that implements the ListAliases operation.

type ListAliasesInput 

type ListAliasesInput struct {

	// The identifier for the entity for which to list the aliases.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the entity exists.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAliasesOutput 

type ListAliasesOutput struct {

	// The entity's paginated aliases.
	Aliases []string

	// The token to use to retrieve the next page of results. The value is "null" when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAliasesPaginator added in v0.30.0 

type ListAliasesPaginator struct {
	// contains filtered or unexported fields
}

ListAliasesPaginator is a paginator for ListAliases

func NewListAliasesPaginator added in v0.30.0 

func NewListAliasesPaginator(client ListAliasesAPIClient, params *ListAliasesInput, optFns ...func(*ListAliasesPaginatorOptions)) *ListAliasesPaginator

NewListAliasesPaginator returns a new ListAliasesPaginator

func (*ListAliasesPaginator) HasMorePages added in v0.30.0 

func (p *ListAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAliasesPaginator) NextPage added in v0.30.0 

func (p *ListAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAliasesOutput, error)

NextPage retrieves the next ListAliases page.

type ListAliasesPaginatorOptions added in v0.30.0 

type ListAliasesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAliasesPaginatorOptions is the paginator options for ListAliases

type ListAvailabilityConfigurationsAPIClient added in v1.16.0 

type ListAvailabilityConfigurationsAPIClient interface {
	ListAvailabilityConfigurations(context.Context, *ListAvailabilityConfigurationsInput, ...func(*Options)) (*ListAvailabilityConfigurationsOutput, error)
}

ListAvailabilityConfigurationsAPIClient is a client that implements the ListAvailabilityConfigurations operation.

type ListAvailabilityConfigurationsInput added in v1.16.0 

type ListAvailabilityConfigurationsInput struct {

	// The WorkMail organization for which the AvailabilityConfiguration 's will be
	// listed.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// require a token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAvailabilityConfigurationsOutput added in v1.16.0 

type ListAvailabilityConfigurationsOutput struct {

	// The list of AvailabilityConfiguration 's that exist for the specified WorkMail
	// organization.
	AvailabilityConfigurations []types.AvailabilityConfiguration

	// The token to use to retrieve the next page of results. The value is null when
	// there are no further results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAvailabilityConfigurationsPaginator added in v1.16.0 

type ListAvailabilityConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListAvailabilityConfigurationsPaginator is a paginator for ListAvailabilityConfigurations

func NewListAvailabilityConfigurationsPaginator added in v1.16.0 

func NewListAvailabilityConfigurationsPaginator(client ListAvailabilityConfigurationsAPIClient, params *ListAvailabilityConfigurationsInput, optFns ...func(*ListAvailabilityConfigurationsPaginatorOptions)) *ListAvailabilityConfigurationsPaginator

NewListAvailabilityConfigurationsPaginator returns a new ListAvailabilityConfigurationsPaginator

func (*ListAvailabilityConfigurationsPaginator) HasMorePages added in v1.16.0 

func (p *ListAvailabilityConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAvailabilityConfigurationsPaginator) NextPage added in v1.16.0 

func (p *ListAvailabilityConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAvailabilityConfigurationsOutput, error)

NextPage retrieves the next ListAvailabilityConfigurations page.

type ListAvailabilityConfigurationsPaginatorOptions added in v1.16.0 

type ListAvailabilityConfigurationsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAvailabilityConfigurationsPaginatorOptions is the paginator options for ListAvailabilityConfigurations

type ListGroupMembersAPIClient added in v0.30.0 

type ListGroupMembersAPIClient interface {
	ListGroupMembers(context.Context, *ListGroupMembersInput, ...func(*Options)) (*ListGroupMembersOutput, error)
}

ListGroupMembersAPIClient is a client that implements the ListGroupMembers operation.

type ListGroupMembersInput 

type ListGroupMembersInput struct {

	// The identifier for the group to which the members (users or groups) are
	// associated. The identifier can accept GroupId, Groupname, or email. The
	// following identity formats are available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: group@domain.tld
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupMembersOutput 

type ListGroupMembersOutput struct {

	// The members associated to the group.
	Members []types.Member

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupMembersPaginator added in v0.30.0 

type ListGroupMembersPaginator struct {
	// contains filtered or unexported fields
}

ListGroupMembersPaginator is a paginator for ListGroupMembers

func NewListGroupMembersPaginator added in v0.30.0 

func NewListGroupMembersPaginator(client ListGroupMembersAPIClient, params *ListGroupMembersInput, optFns ...func(*ListGroupMembersPaginatorOptions)) *ListGroupMembersPaginator

NewListGroupMembersPaginator returns a new ListGroupMembersPaginator

func (*ListGroupMembersPaginator) HasMorePages added in v0.30.0 

func (p *ListGroupMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupMembersPaginator) NextPage added in v0.30.0 

func (p *ListGroupMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupMembersOutput, error)

NextPage retrieves the next ListGroupMembers page.

type ListGroupMembersPaginatorOptions added in v0.30.0 

type ListGroupMembersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGroupMembersPaginatorOptions is the paginator options for ListGroupMembers

type ListGroupsAPIClient added in v0.30.0 

type ListGroupsAPIClient interface {
	ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
}

ListGroupsAPIClient is a client that implements the ListGroups operation.

type ListGroupsForEntityAPIClient added in v1.20.0 

type ListGroupsForEntityAPIClient interface {
	ListGroupsForEntity(context.Context, *ListGroupsForEntityInput, ...func(*Options)) (*ListGroupsForEntityOutput, error)
}

ListGroupsForEntityAPIClient is a client that implements the ListGroupsForEntity operation.

type ListGroupsForEntityInput added in v1.20.0 

type ListGroupsForEntityInput struct {

	// The identifier for the entity. The entity ID can accept UserId or GroupID,
	// Username or Groupname, or email.
	//   - Entity ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the entity exists.
	//
	// This member is required.
	OrganizationId *string

	// Limit the search results based on the filter criteria.
	Filters *types.ListGroupsForEntityFilters

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsForEntityOutput added in v1.20.0 

type ListGroupsForEntityOutput struct {

	// The overview of groups in an organization.
	Groups []types.GroupIdentifier

	// The token to use to retrieve the next page of results. This value is `null`
	// when there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupsForEntityPaginator added in v1.20.0 

type ListGroupsForEntityPaginator struct {
	// contains filtered or unexported fields
}

ListGroupsForEntityPaginator is a paginator for ListGroupsForEntity

func NewListGroupsForEntityPaginator added in v1.20.0 

func NewListGroupsForEntityPaginator(client ListGroupsForEntityAPIClient, params *ListGroupsForEntityInput, optFns ...func(*ListGroupsForEntityPaginatorOptions)) *ListGroupsForEntityPaginator

NewListGroupsForEntityPaginator returns a new ListGroupsForEntityPaginator

func (*ListGroupsForEntityPaginator) HasMorePages added in v1.20.0 

func (p *ListGroupsForEntityPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupsForEntityPaginator) NextPage added in v1.20.0 

func (p *ListGroupsForEntityPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsForEntityOutput, error)

NextPage retrieves the next ListGroupsForEntity page.

type ListGroupsForEntityPaginatorOptions added in v1.20.0 

type ListGroupsForEntityPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGroupsForEntityPaginatorOptions is the paginator options for ListGroupsForEntity

type ListGroupsInput 

type ListGroupsInput struct {

	// The identifier for the organization under which the groups exist.
	//
	// This member is required.
	OrganizationId *string

	// Limit the search results based on the filter criteria. Only one filter per
	// request is supported.
	Filters *types.ListGroupsFilters

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsOutput 

type ListGroupsOutput struct {

	// The overview of groups for an organization.
	Groups []types.Group

	// The token to use to retrieve the next page of results. The value is "null" when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupsPaginator added in v0.30.0 

type ListGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListGroupsPaginator is a paginator for ListGroups

func NewListGroupsPaginator added in v0.30.0 

func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator

NewListGroupsPaginator returns a new ListGroupsPaginator

func (*ListGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupsPaginator) NextPage added in v0.30.0 

func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)

NextPage retrieves the next ListGroups page.

type ListGroupsPaginatorOptions added in v0.30.0 

type ListGroupsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGroupsPaginatorOptions is the paginator options for ListGroups

type ListImpersonationRolesAPIClient added in v1.17.0 

type ListImpersonationRolesAPIClient interface {
	ListImpersonationRoles(context.Context, *ListImpersonationRolesInput, ...func(*Options)) (*ListImpersonationRolesOutput, error)
}

ListImpersonationRolesAPIClient is a client that implements the ListImpersonationRoles operation.

type ListImpersonationRolesInput added in v1.17.0 

type ListImpersonationRolesInput struct {

	// The WorkMail organization to which the listed impersonation roles belong.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results returned in a single call.
	MaxResults *int32

	// The token used to retrieve the next page of results. The first call doesn't
	// require a token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImpersonationRolesOutput added in v1.17.0 

type ListImpersonationRolesOutput struct {

	// The token to retrieve the next page of results. The value is null when there
	// are no results to return.
	NextToken *string

	// The list of impersonation roles under the given WorkMail organization.
	Roles []types.ImpersonationRole

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImpersonationRolesPaginator added in v1.17.0 

type ListImpersonationRolesPaginator struct {
	// contains filtered or unexported fields
}

ListImpersonationRolesPaginator is a paginator for ListImpersonationRoles

func NewListImpersonationRolesPaginator added in v1.17.0 

func NewListImpersonationRolesPaginator(client ListImpersonationRolesAPIClient, params *ListImpersonationRolesInput, optFns ...func(*ListImpersonationRolesPaginatorOptions)) *ListImpersonationRolesPaginator

NewListImpersonationRolesPaginator returns a new ListImpersonationRolesPaginator

func (*ListImpersonationRolesPaginator) HasMorePages added in v1.17.0 

func (p *ListImpersonationRolesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImpersonationRolesPaginator) NextPage added in v1.17.0 

func (p *ListImpersonationRolesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImpersonationRolesOutput, error)

NextPage retrieves the next ListImpersonationRoles page.

type ListImpersonationRolesPaginatorOptions added in v1.17.0 

type ListImpersonationRolesPaginatorOptions struct {
	// The maximum number of results returned in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImpersonationRolesPaginatorOptions is the paginator options for ListImpersonationRoles

type ListMailDomainsAPIClient added in v1.8.0 

type ListMailDomainsAPIClient interface {
	ListMailDomains(context.Context, *ListMailDomainsInput, ...func(*Options)) (*ListMailDomainsOutput, error)
}

ListMailDomainsAPIClient is a client that implements the ListMailDomains operation.

type ListMailDomainsInput added in v1.8.0 

type ListMailDomainsInput struct {

	// The WorkMail organization for which to list domains.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// require a token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMailDomainsOutput added in v1.8.0 

type ListMailDomainsOutput struct {

	// The list of mail domain summaries, specifying domains that exist in the
	// specified WorkMail organization, along with the information about whether the
	// domain is or isn't the default.
	MailDomains []types.MailDomainSummary

	// The token to use to retrieve the next page of results. The value becomes null
	// when there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMailDomainsPaginator added in v1.8.0 

type ListMailDomainsPaginator struct {
	// contains filtered or unexported fields
}

ListMailDomainsPaginator is a paginator for ListMailDomains

func NewListMailDomainsPaginator added in v1.8.0 

func NewListMailDomainsPaginator(client ListMailDomainsAPIClient, params *ListMailDomainsInput, optFns ...func(*ListMailDomainsPaginatorOptions)) *ListMailDomainsPaginator

NewListMailDomainsPaginator returns a new ListMailDomainsPaginator

func (*ListMailDomainsPaginator) HasMorePages added in v1.8.0 

func (p *ListMailDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMailDomainsPaginator) NextPage added in v1.8.0 

func (p *ListMailDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMailDomainsOutput, error)

NextPage retrieves the next ListMailDomains page.

type ListMailDomainsPaginatorOptions added in v1.8.0 

type ListMailDomainsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMailDomainsPaginatorOptions is the paginator options for ListMailDomains

type ListMailboxExportJobsAPIClient added in v0.30.0 

type ListMailboxExportJobsAPIClient interface {
	ListMailboxExportJobs(context.Context, *ListMailboxExportJobsInput, ...func(*Options)) (*ListMailboxExportJobsOutput, error)
}

ListMailboxExportJobsAPIClient is a client that implements the ListMailboxExportJobs operation.

type ListMailboxExportJobsInput added in v0.29.0 

type ListMailboxExportJobsInput struct {

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMailboxExportJobsOutput added in v0.29.0 

type ListMailboxExportJobsOutput struct {

	// The mailbox export job details.
	Jobs []types.MailboxExportJob

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMailboxExportJobsPaginator added in v0.30.0 

type ListMailboxExportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListMailboxExportJobsPaginator is a paginator for ListMailboxExportJobs

func NewListMailboxExportJobsPaginator added in v0.30.0 

func NewListMailboxExportJobsPaginator(client ListMailboxExportJobsAPIClient, params *ListMailboxExportJobsInput, optFns ...func(*ListMailboxExportJobsPaginatorOptions)) *ListMailboxExportJobsPaginator

NewListMailboxExportJobsPaginator returns a new ListMailboxExportJobsPaginator

func (*ListMailboxExportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListMailboxExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMailboxExportJobsPaginator) NextPage added in v0.30.0 

func (p *ListMailboxExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMailboxExportJobsOutput, error)

NextPage retrieves the next ListMailboxExportJobs page.

type ListMailboxExportJobsPaginatorOptions added in v0.30.0 

type ListMailboxExportJobsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMailboxExportJobsPaginatorOptions is the paginator options for ListMailboxExportJobs

type ListMailboxPermissionsAPIClient added in v0.30.0 

type ListMailboxPermissionsAPIClient interface {
	ListMailboxPermissions(context.Context, *ListMailboxPermissionsInput, ...func(*Options)) (*ListMailboxPermissionsOutput, error)
}

ListMailboxPermissionsAPIClient is a client that implements the ListMailboxPermissions operation.

type ListMailboxPermissionsInput 

type ListMailboxPermissionsInput struct {

	// The identifier of the user, or resource for which to list mailbox permissions.
	// The entity ID can accept UserId or ResourceId, Username or Resourcename, or
	// email.
	//   - Entity ID: 12345678-1234-1234-1234-123456789012, or
	//   r-0123456789a0123456789b0123456789
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMailboxPermissionsOutput 

type ListMailboxPermissionsOutput struct {

	// The token to use to retrieve the next page of results. The value is "null" when
	// there are no more results to return.
	NextToken *string

	// One page of the user, group, or resource mailbox permissions.
	Permissions []types.Permission

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMailboxPermissionsPaginator added in v0.30.0 

type ListMailboxPermissionsPaginator struct {
	// contains filtered or unexported fields
}

ListMailboxPermissionsPaginator is a paginator for ListMailboxPermissions

func NewListMailboxPermissionsPaginator added in v0.30.0 

func NewListMailboxPermissionsPaginator(client ListMailboxPermissionsAPIClient, params *ListMailboxPermissionsInput, optFns ...func(*ListMailboxPermissionsPaginatorOptions)) *ListMailboxPermissionsPaginator

NewListMailboxPermissionsPaginator returns a new ListMailboxPermissionsPaginator

func (*ListMailboxPermissionsPaginator) HasMorePages added in v0.30.0 

func (p *ListMailboxPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMailboxPermissionsPaginator) NextPage added in v0.30.0 

func (p *ListMailboxPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMailboxPermissionsOutput, error)

NextPage retrieves the next ListMailboxPermissions page.

type ListMailboxPermissionsPaginatorOptions added in v0.30.0 

type ListMailboxPermissionsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMailboxPermissionsPaginatorOptions is the paginator options for ListMailboxPermissions

type ListMobileDeviceAccessOverridesAPIClient added in v1.6.0 

type ListMobileDeviceAccessOverridesAPIClient interface {
	ListMobileDeviceAccessOverrides(context.Context, *ListMobileDeviceAccessOverridesInput, ...func(*Options)) (*ListMobileDeviceAccessOverridesOutput, error)
}

ListMobileDeviceAccessOverridesAPIClient is a client that implements the ListMobileDeviceAccessOverrides operation.

type ListMobileDeviceAccessOverridesInput added in v1.6.0 

type ListMobileDeviceAccessOverridesInput struct {

	// The WorkMail organization under which to list mobile device access overrides.
	//
	// This member is required.
	OrganizationId *string

	// The mobile device to which the access override applies.
	DeviceId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// require a token.
	NextToken *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 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	UserId *string
	// contains filtered or unexported fields
}

type ListMobileDeviceAccessOverridesOutput added in v1.6.0 

type ListMobileDeviceAccessOverridesOutput struct {

	// The token to use to retrieve the next page of results. The value is “null” when
	// there are no more results to return.
	NextToken *string

	// The list of mobile device access overrides that exist for the specified
	// WorkMail organization and user.
	Overrides []types.MobileDeviceAccessOverride

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMobileDeviceAccessOverridesPaginator added in v1.6.0 

type ListMobileDeviceAccessOverridesPaginator struct {
	// contains filtered or unexported fields
}

ListMobileDeviceAccessOverridesPaginator is a paginator for ListMobileDeviceAccessOverrides

func NewListMobileDeviceAccessOverridesPaginator added in v1.6.0 

func NewListMobileDeviceAccessOverridesPaginator(client ListMobileDeviceAccessOverridesAPIClient, params *ListMobileDeviceAccessOverridesInput, optFns ...func(*ListMobileDeviceAccessOverridesPaginatorOptions)) *ListMobileDeviceAccessOverridesPaginator

NewListMobileDeviceAccessOverridesPaginator returns a new ListMobileDeviceAccessOverridesPaginator

func (*ListMobileDeviceAccessOverridesPaginator) HasMorePages added in v1.6.0 

func (p *ListMobileDeviceAccessOverridesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMobileDeviceAccessOverridesPaginator) NextPage added in v1.6.0 

func (p *ListMobileDeviceAccessOverridesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMobileDeviceAccessOverridesOutput, error)

NextPage retrieves the next ListMobileDeviceAccessOverrides page.

type ListMobileDeviceAccessOverridesPaginatorOptions added in v1.6.0 

type ListMobileDeviceAccessOverridesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMobileDeviceAccessOverridesPaginatorOptions is the paginator options for ListMobileDeviceAccessOverrides

type ListMobileDeviceAccessRulesInput added in v1.2.0 

type ListMobileDeviceAccessRulesInput struct {

	// The WorkMail organization for which to list the rules.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type ListMobileDeviceAccessRulesOutput added in v1.2.0 

type ListMobileDeviceAccessRulesOutput struct {

	// The list of mobile device access rules that exist under the specified WorkMail
	// organization.
	Rules []types.MobileDeviceAccessRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListOrganizationsAPIClient added in v0.30.0 

type ListOrganizationsAPIClient interface {
	ListOrganizations(context.Context, *ListOrganizationsInput, ...func(*Options)) (*ListOrganizationsOutput, error)
}

ListOrganizationsAPIClient is a client that implements the ListOrganizations operation.

type ListOrganizationsInput 

type ListOrganizationsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOrganizationsOutput 

type ListOrganizationsOutput struct {

	// The token to use to retrieve the next page of results. The value is "null" when
	// there are no more results to return.
	NextToken *string

	// The overview of owned organizations presented as a list of organization
	// summaries.
	OrganizationSummaries []types.OrganizationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListOrganizationsPaginator added in v0.30.0 

type ListOrganizationsPaginator struct {
	// contains filtered or unexported fields
}

ListOrganizationsPaginator is a paginator for ListOrganizations

func NewListOrganizationsPaginator added in v0.30.0 

func NewListOrganizationsPaginator(client ListOrganizationsAPIClient, params *ListOrganizationsInput, optFns ...func(*ListOrganizationsPaginatorOptions)) *ListOrganizationsPaginator

NewListOrganizationsPaginator returns a new ListOrganizationsPaginator

func (*ListOrganizationsPaginator) HasMorePages added in v0.30.0 

func (p *ListOrganizationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrganizationsPaginator) NextPage added in v0.30.0 

func (p *ListOrganizationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationsOutput, error)

NextPage retrieves the next ListOrganizations page.

type ListOrganizationsPaginatorOptions added in v0.30.0 

type ListOrganizationsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListOrganizationsPaginatorOptions is the paginator options for ListOrganizations

type ListResourceDelegatesAPIClient added in v0.30.0 

type ListResourceDelegatesAPIClient interface {
	ListResourceDelegates(context.Context, *ListResourceDelegatesInput, ...func(*Options)) (*ListResourceDelegatesOutput, error)
}

ListResourceDelegatesAPIClient is a client that implements the ListResourceDelegates operation.

type ListResourceDelegatesInput 

type ListResourceDelegatesInput struct {

	// The identifier for the organization that contains the resource for which
	// delegates are listed.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the resource whose delegates are listed. The identifier can
	// accept ResourceId, Resourcename, or email. The following identity formats are
	// available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Email address: resource@domain.tld
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string

	// The number of maximum results in a page.
	MaxResults *int32

	// The token used to paginate through the delegates associated with a resource.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceDelegatesOutput 

type ListResourceDelegatesOutput struct {

	// One page of the resource's delegates.
	Delegates []types.Delegate

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceDelegatesPaginator added in v0.30.0 

type ListResourceDelegatesPaginator struct {
	// contains filtered or unexported fields
}

ListResourceDelegatesPaginator is a paginator for ListResourceDelegates

func NewListResourceDelegatesPaginator added in v0.30.0 

func NewListResourceDelegatesPaginator(client ListResourceDelegatesAPIClient, params *ListResourceDelegatesInput, optFns ...func(*ListResourceDelegatesPaginatorOptions)) *ListResourceDelegatesPaginator

NewListResourceDelegatesPaginator returns a new ListResourceDelegatesPaginator

func (*ListResourceDelegatesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourceDelegatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceDelegatesPaginator) NextPage added in v0.30.0 

func (p *ListResourceDelegatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceDelegatesOutput, error)

NextPage retrieves the next ListResourceDelegates page.

type ListResourceDelegatesPaginatorOptions added in v0.30.0 

type ListResourceDelegatesPaginatorOptions struct {
	// The number of maximum results in a page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourceDelegatesPaginatorOptions is the paginator options for ListResourceDelegates

type ListResourcesAPIClient added in v0.30.0 

type ListResourcesAPIClient interface {
	ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}

ListResourcesAPIClient is a client that implements the ListResources operation.

type ListResourcesInput 

type ListResourcesInput struct {

	// The identifier for the organization under which the resources exist.
	//
	// This member is required.
	OrganizationId *string

	// Limit the resource search results based on the filter criteria. You can only
	// use one filter per request.
	Filters *types.ListResourcesFilters

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourcesOutput 

type ListResourcesOutput struct {

	// 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.
	NextToken *string

	// One page of the organization's resource representation.
	Resources []types.Resource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourcesPaginator added in v0.30.0 

type ListResourcesPaginator struct {
	// contains filtered or unexported fields
}

ListResourcesPaginator is a paginator for ListResources

func NewListResourcesPaginator added in v0.30.0 

func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator

NewListResourcesPaginator returns a new ListResourcesPaginator

func (*ListResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesPaginator) NextPage added in v0.30.0 

func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)

NextPage retrieves the next ListResources page.

type ListResourcesPaginatorOptions added in v0.30.0 

type ListResourcesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcesPaginatorOptions is the paginator options for ListResources

type ListTagsForResourceInput added in v0.29.0 

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v0.29.0 

type ListTagsForResourceOutput struct {

	// A list of tag key-value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsersAPIClient added in v0.30.0 

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersInput 

type ListUsersInput struct {

	// The identifier for the organization under which the users exist.
	//
	// This member is required.
	OrganizationId *string

	// Limit the user search results based on the filter criteria. You can only use
	// one filter per request.
	Filters *types.ListUsersFilters

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUsersOutput 

type ListUsersOutput struct {

	// The token to use to retrieve the next page of results. This value is `null`
	// when there are no more results to return.
	NextToken *string

	// The overview of users for an organization.
	Users []types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsersPaginator added in v0.30.0 

type ListUsersPaginator struct {
	// contains filtered or unexported fields
}

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator added in v0.30.0 

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages added in v0.30.0 

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage added in v0.30.0 

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions added in v0.30.0 

type ListUsersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUsersPaginatorOptions is the paginator options for ListUsers

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.22.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutAccessControlRuleInput added in v0.29.0 

type PutAccessControlRuleInput struct {

	// The rule description.
	//
	// This member is required.
	Description *string

	// The rule effect.
	//
	// This member is required.
	Effect types.AccessControlRuleEffect

	// The rule name.
	//
	// This member is required.
	Name *string

	// The identifier of the organization.
	//
	// This member is required.
	OrganizationId *string

	// Access protocol actions to include in the rule. Valid values include ActiveSync
	// , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .
	Actions []string

	// Impersonation role IDs to include in the rule.
	ImpersonationRoleIds []string

	// IPv4 CIDR ranges to include in the rule.
	IpRanges []string

	// Access protocol actions to exclude from the rule. Valid values include
	// ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .
	NotActions []string

	// Impersonation role IDs to exclude from the rule.
	NotImpersonationRoleIds []string

	// IPv4 CIDR ranges to exclude from the rule.
	NotIpRanges []string

	// User IDs to exclude from the rule.
	NotUserIds []string

	// User IDs to include in the rule.
	UserIds []string
	// contains filtered or unexported fields
}

type PutAccessControlRuleOutput added in v0.29.0 

type PutAccessControlRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutEmailMonitoringConfigurationInput added in v1.11.0 

type PutEmailMonitoringConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the
	// email monitoring configuration.
	//
	// This member is required.
	LogGroupArn *string

	// The ID of the organization for which the email monitoring configuration is set.
	//
	// This member is required.
	OrganizationId *string

	// The Amazon Resource Name (ARN) of the IAM Role associated with the email
	// monitoring configuration.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

type PutEmailMonitoringConfigurationOutput added in v1.11.0 

type PutEmailMonitoringConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutInboundDmarcSettingsInput added in v1.7.0 

type PutInboundDmarcSettingsInput struct {

	// Enforces or suspends a policy after it's applied.
	//
	// This member is required.
	Enforced *bool

	// The ID of the organization that you are applying the DMARC policy to.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type PutInboundDmarcSettingsOutput added in v1.7.0 

type PutInboundDmarcSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutMailboxPermissionsInput 

type PutMailboxPermissionsInput struct {

	// The identifier of the user or resource for which to update mailbox permissions.
	// The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename,
	// or Groupname, or email.
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier of the user, group, or resource to which to grant the
	// permissions. The identifier can be UserId, ResourceID, or Group Id, Username,
	// Resourcename, or Groupname, or email.
	//   - Grantee ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: grantee@domain.tld
	//   - Grantee name: grantee
	//
	// This member is required.
	GranteeId *string

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	OrganizationId *string

	// 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.
	//
	// This member is required.
	PermissionValues []types.PermissionType
	// contains filtered or unexported fields
}

type PutMailboxPermissionsOutput 

type PutMailboxPermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutMobileDeviceAccessOverrideInput added in v1.6.0 

type PutMobileDeviceAccessOverrideInput struct {

	// The mobile device for which you create the override. DeviceId is case
	// insensitive.
	//
	// This member is required.
	DeviceId *string

	// The effect of the override, ALLOW or DENY .
	//
	// This member is required.
	Effect types.MobileDeviceAccessRuleEffect

	// Identifies the WorkMail organization for which you create the override.
	//
	// This member is required.
	OrganizationId *string

	// The WorkMail user for which you create the override. Accepts the following
	// types of user identities:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string

	// A description of the override.
	Description *string
	// contains filtered or unexported fields
}

type PutMobileDeviceAccessOverrideOutput added in v1.6.0 

type PutMobileDeviceAccessOverrideOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutRetentionPolicyInput added in v0.29.0 

type PutRetentionPolicyInput struct {

	// The retention policy folder configurations.
	//
	// This member is required.
	FolderConfigurations []types.FolderConfiguration

	// The retention policy name.
	//
	// This member is required.
	Name *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string

	// The retention policy description.
	Description *string

	// The retention policy ID.
	Id *string
	// contains filtered or unexported fields
}

type PutRetentionPolicyOutput added in v0.29.0 

type PutRetentionPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterMailDomainInput added in v1.8.0 

type RegisterMailDomainInput struct {

	// The name of the mail domain to create in WorkMail and SES.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization under which you're creating the domain.
	//
	// This member is required.
	OrganizationId *string

	// Idempotency token used when retrying requests.
	ClientToken *string
	// contains filtered or unexported fields
}

type RegisterMailDomainOutput added in v1.8.0 

type RegisterMailDomainOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterToWorkMailInput 

type RegisterToWorkMailInput struct {

	// The email for the user, group, or resource to be updated.
	//
	// This member is required.
	Email *string

	// The identifier for the user, group, or resource to be updated. The identifier
	// can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or
	// Groupname. The following identity formats are available:
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type RegisterToWorkMailOutput 

type RegisterToWorkMailOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResetPasswordInput 

type ResetPasswordInput struct {

	// The identifier of the organization that contains the user for which the
	// password is reset.
	//
	// This member is required.
	OrganizationId *string

	// The new password for the user.
	//
	// This member is required.
	Password *string

	// The identifier of the user for whom the password is reset.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type ResetPasswordOutput 

type ResetPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartMailboxExportJobInput added in v0.29.0 

type StartMailboxExportJobInput struct {

	// The idempotency token for the client request.
	//
	// This member is required.
	ClientToken *string

	// The identifier of the user or resource associated with the mailbox. The
	// identifier can accept UserId or ResourceId, Username or Resourcename, or email.
	// The following identity formats are available:
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789 , or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS
	// KMS) key that encrypts the exported mailbox content.
	//
	// This member is required.
	KmsKeyArn *string

	// The identifier associated with the organization.
	//
	// This member is required.
	OrganizationId *string

	// The ARN of the AWS Identity and Access Management (IAM) role that grants write
	// permission to the S3 bucket.
	//
	// This member is required.
	RoleArn *string

	// The name of the S3 bucket.
	//
	// This member is required.
	S3BucketName *string

	// The S3 bucket prefix.
	//
	// This member is required.
	S3Prefix *string

	// The mailbox export job description.
	Description *string
	// contains filtered or unexported fields
}

type StartMailboxExportJobOutput added in v0.29.0 

type StartMailboxExportJobOutput struct {

	// The job ID.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput added in v0.29.0 

type TagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag key-value pairs.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v0.29.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestAvailabilityConfigurationInput added in v1.16.0 

type TestAvailabilityConfigurationInput struct {

	// The WorkMail organization where the availability provider will be tested.
	//
	// This member is required.
	OrganizationId *string

	// The domain to which the provider applies. If this field is provided, a stored
	// availability provider associated to this domain name will be tested.
	DomainName *string

	// Describes an EWS based availability provider. This is only used as input to the
	// service.
	EwsProvider *types.EwsAvailabilityProvider

	// Describes a Lambda based availability provider.
	LambdaProvider *types.LambdaAvailabilityProvider
	// contains filtered or unexported fields
}

type TestAvailabilityConfigurationOutput added in v1.16.0 

type TestAvailabilityConfigurationOutput struct {

	// String containing the reason for a failed test if TestPassed is false.
	FailureReason *string

	// Boolean indicating whether the test passed or failed.
	TestPassed bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v0.29.0 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v0.29.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAvailabilityConfigurationInput added in v1.16.0 

type UpdateAvailabilityConfigurationInput struct {

	// The domain to which the provider applies the availability configuration.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which the AvailabilityConfiguration will be
	// updated.
	//
	// This member is required.
	OrganizationId *string

	// The EWS availability provider definition. The request must contain exactly one
	// provider definition, either EwsProvider or LambdaProvider . The previously
	// stored provider will be overridden by the one provided.
	EwsProvider *types.EwsAvailabilityProvider

	// The Lambda availability provider definition. The request must contain exactly
	// one provider definition, either EwsProvider or LambdaProvider . The previously
	// stored provider will be overridden by the one provided.
	LambdaProvider *types.LambdaAvailabilityProvider
	// contains filtered or unexported fields
}

type UpdateAvailabilityConfigurationOutput added in v1.16.0 

type UpdateAvailabilityConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDefaultMailDomainInput added in v1.8.0 

type UpdateDefaultMailDomainInput struct {

	// The domain name that will become the default domain.
	//
	// This member is required.
	DomainName *string

	// The WorkMail organization for which to list domains.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type UpdateDefaultMailDomainOutput added in v1.8.0 

type UpdateDefaultMailDomainOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGroupInput added in v1.20.0 

type UpdateGroupInput struct {

	// The identifier for the group to be updated. The identifier can accept GroupId,
	// Groupname, or email. The following identity formats are available:
	//   - Group ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: group@domain.tld
	//   - Group name: group
	//
	// This member is required.
	GroupId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string

	// If enabled, the group is hidden from the global address list.
	HiddenFromGlobalAddressList *bool
	// contains filtered or unexported fields
}

type UpdateGroupOutput added in v1.20.0 

type UpdateGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateImpersonationRoleInput added in v1.17.0 

type UpdateImpersonationRoleInput struct {

	// The ID of the impersonation role to update.
	//
	// This member is required.
	ImpersonationRoleId *string

	// The updated impersonation role name.
	//
	// This member is required.
	Name *string

	// The WorkMail organization that contains the impersonation role to update.
	//
	// This member is required.
	OrganizationId *string

	// The updated list of rules.
	//
	// This member is required.
	Rules []types.ImpersonationRule

	// The updated impersonation role type.
	//
	// This member is required.
	Type types.ImpersonationRoleType

	// The updated impersonation role description.
	Description *string
	// contains filtered or unexported fields
}

type UpdateImpersonationRoleOutput added in v1.17.0 

type UpdateImpersonationRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMailboxQuotaInput 

type UpdateMailboxQuotaInput struct {

	// The updated mailbox quota, in MB, for the specified user.
	//
	// This member is required.
	MailboxQuota *int32

	// The identifier for the organization that contains the user for whom to update
	// the mailbox quota.
	//
	// This member is required.
	OrganizationId *string

	// The identifer for the user for whom to update the mailbox quota. The identifier
	// can be the UserId, Username, or email. The following identity formats are
	// available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type UpdateMailboxQuotaOutput 

type UpdateMailboxQuotaOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMobileDeviceAccessRuleInput added in v1.2.0 

type UpdateMobileDeviceAccessRuleInput struct {

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY .
	//
	// This member is required.
	Effect types.MobileDeviceAccessRuleEffect

	// The identifier of the rule to be updated.
	//
	// This member is required.
	MobileDeviceAccessRuleId *string

	// The updated rule name.
	//
	// This member is required.
	Name *string

	// The WorkMail organization under which the rule will be updated.
	//
	// This member is required.
	OrganizationId *string

	// The updated rule description.
	Description *string

	// Device models that the updated rule will match.
	DeviceModels []string

	// Device operating systems that the updated rule will match.
	DeviceOperatingSystems []string

	// Device types that the updated rule will match.
	DeviceTypes []string

	// User agents that the updated rule will match.
	DeviceUserAgents []string

	// Device models that the updated rule will not match. All other device models
	// will match.
	NotDeviceModels []string

	// Device operating systems that the updated rule will not match. All other device
	// operating systems will match.
	NotDeviceOperatingSystems []string

	// Device types that the updated rule will not match. All other device types will
	// match.
	NotDeviceTypes []string

	// User agents that the updated rule will not match. All other user agents will
	// match.
	NotDeviceUserAgents []string
	// contains filtered or unexported fields
}

type UpdateMobileDeviceAccessRuleOutput added in v1.2.0 

type UpdateMobileDeviceAccessRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePrimaryEmailAddressInput 

type UpdatePrimaryEmailAddressInput struct {

	// The value of the email to be updated as primary.
	//
	// This member is required.
	Email *string

	// The user, group, or resource to update. The identifier can accept UseriD,
	// ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The
	// following identity formats are available:
	//   - Entity ID: 12345678-1234-1234-1234-123456789012,
	//   r-0123456789a0123456789b0123456789, or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: entity@domain.tld
	//   - Entity name: entity
	//
	// This member is required.
	EntityId *string

	// The organization that contains the user, group, or resource to update.
	//
	// This member is required.
	OrganizationId *string
	// contains filtered or unexported fields
}

type UpdatePrimaryEmailAddressOutput 

type UpdatePrimaryEmailAddressOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourceInput 

type UpdateResourceInput struct {

	// The identifier associated with the organization for which the resource is
	// updated.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be updated. The identifier can accept
	// ResourceId, Resourcename, or email. The following identity formats are
	// available:
	//   - Resource ID: r-0123456789a0123456789b0123456789
	//   - Email address: resource@domain.tld
	//   - Resource name: resource
	//
	// This member is required.
	ResourceId *string

	// The resource's booking options to be updated.
	BookingOptions *types.BookingOptions

	// Updates the resource description.
	Description *string

	// If enabled, the resource is hidden from the global address list.
	HiddenFromGlobalAddressList *bool

	// The name of the resource to be updated.
	Name *string

	// Updates the resource type.
	Type types.ResourceType
	// contains filtered or unexported fields
}

type UpdateResourceOutput 

type UpdateResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateUserInput added in v1.20.0 

type UpdateUserInput struct {

	// The identifier for the organization under which the user exists.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the user to be updated. The identifier can be the UserId,
	// Username, or email. The following identity formats are available:
	//   - User ID: 12345678-1234-1234-1234-123456789012 or
	//   S-1-1-12-1234567890-123456789-123456789-1234
	//   - Email address: user@domain.tld
	//   - User name: user
	//
	// This member is required.
	UserId *string

	// Updates the user's city.
	City *string

	// Updates the user's company.
	Company *string

	// Updates the user's country.
	Country *string

	// Updates the user's department.
	Department *string

	// Updates the display name of the user.
	DisplayName *string

	// Updates the user's first name.
	FirstName *string

	// If enabled, the user is hidden from the global address list.
	HiddenFromGlobalAddressList *bool

	// Updates the user's initials.
	Initials *string

	// Updates the user's job title.
	JobTitle *string

	// Updates the user's last name.
	LastName *string

	// Updates the user's office.
	Office *string

	// Updates the user role. You cannot pass SYSTEM_USER or RESOURCE.
	Role types.UserRole

	// Updates the user's street address.
	Street *string

	// Updates the user's contact details.
	Telephone *string

	// Updates the user's zipcode.
	ZipCode *string
	// contains filtered or unexported fields
}

type UpdateUserOutput added in v1.20.0 

type UpdateUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.