workmail

package
v1.38.18 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 10 Imported by: 28

Documentation

Overview

Package workmail provides the client and types for making API requests to Amazon WorkMail.

Amazon 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.

See https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01 for more information on this service.

See workmail package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workmail/

Using the Client

To contact Amazon WorkMail with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon WorkMail client WorkMail for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workmail/#New

Index

Constants

View Source 
const (
	// AccessControlRuleEffectAllow is a AccessControlRuleEffect enum value
	AccessControlRuleEffectAllow = "ALLOW"

	// AccessControlRuleEffectDeny is a AccessControlRuleEffect enum value
	AccessControlRuleEffectDeny = "DENY"
)
View Source 
const (
	// EntityStateEnabled is a EntityState enum value
	EntityStateEnabled = "ENABLED"

	// EntityStateDisabled is a EntityState enum value
	EntityStateDisabled = "DISABLED"

	// EntityStateDeleted is a EntityState enum value
	EntityStateDeleted = "DELETED"
)
View Source 
const (
	// FolderNameInbox is a FolderName enum value
	FolderNameInbox = "INBOX"

	// FolderNameDeletedItems is a FolderName enum value
	FolderNameDeletedItems = "DELETED_ITEMS"

	// FolderNameSentItems is a FolderName enum value
	FolderNameSentItems = "SENT_ITEMS"

	// FolderNameDrafts is a FolderName enum value
	FolderNameDrafts = "DRAFTS"

	// FolderNameJunkEmail is a FolderName enum value
	FolderNameJunkEmail = "JUNK_EMAIL"
)
View Source 
const (
	// MailboxExportJobStateRunning is a MailboxExportJobState enum value
	MailboxExportJobStateRunning = "RUNNING"

	// MailboxExportJobStateCompleted is a MailboxExportJobState enum value
	MailboxExportJobStateCompleted = "COMPLETED"

	// MailboxExportJobStateFailed is a MailboxExportJobState enum value
	MailboxExportJobStateFailed = "FAILED"

	// MailboxExportJobStateCancelled is a MailboxExportJobState enum value
	MailboxExportJobStateCancelled = "CANCELLED"
)
View Source 
const (
	// MemberTypeGroup is a MemberType enum value
	MemberTypeGroup = "GROUP"

	// MemberTypeUser is a MemberType enum value
	MemberTypeUser = "USER"
)
View Source 
const (
	// MobileDeviceAccessRuleEffectAllow is a MobileDeviceAccessRuleEffect enum value
	MobileDeviceAccessRuleEffectAllow = "ALLOW"

	// MobileDeviceAccessRuleEffectDeny is a MobileDeviceAccessRuleEffect enum value
	MobileDeviceAccessRuleEffectDeny = "DENY"
)
View Source 
const (
	// PermissionTypeFullAccess is a PermissionType enum value
	PermissionTypeFullAccess = "FULL_ACCESS"

	// PermissionTypeSendAs is a PermissionType enum value
	PermissionTypeSendAs = "SEND_AS"

	// PermissionTypeSendOnBehalf is a PermissionType enum value
	PermissionTypeSendOnBehalf = "SEND_ON_BEHALF"
)
View Source 
const (
	// ResourceTypeRoom is a ResourceType enum value
	ResourceTypeRoom = "ROOM"

	// ResourceTypeEquipment is a ResourceType enum value
	ResourceTypeEquipment = "EQUIPMENT"
)
View Source 
const (
	// RetentionActionNone is a RetentionAction enum value
	RetentionActionNone = "NONE"

	// RetentionActionDelete is a RetentionAction enum value
	RetentionActionDelete = "DELETE"

	// RetentionActionPermanentlyDelete is a RetentionAction enum value
	RetentionActionPermanentlyDelete = "PERMANENTLY_DELETE"
)
View Source 
const (
	// UserRoleUser is a UserRole enum value
	UserRoleUser = "USER"

	// UserRoleResource is a UserRole enum value
	UserRoleResource = "RESOURCE"

	// UserRoleSystemUser is a UserRole enum value
	UserRoleSystemUser = "SYSTEM_USER"
)
View Source 
const (

	// ErrCodeDirectoryInUseException for service response error code
	// "DirectoryInUseException".
	//
	// The directory is already in use by another WorkMail organization in the same
	// account and Region.
	ErrCodeDirectoryInUseException = "DirectoryInUseException"

	// ErrCodeDirectoryServiceAuthenticationFailedException for service response error code
	// "DirectoryServiceAuthenticationFailedException".
	//
	// The directory service doesn't recognize the credentials supplied by WorkMail.
	ErrCodeDirectoryServiceAuthenticationFailedException = "DirectoryServiceAuthenticationFailedException"

	// ErrCodeDirectoryUnavailableException for service response error code
	// "DirectoryUnavailableException".
	//
	// The directory is unavailable. It might be located in another Region or deleted.
	ErrCodeDirectoryUnavailableException = "DirectoryUnavailableException"

	// ErrCodeEmailAddressInUseException for service response error code
	// "EmailAddressInUseException".
	//
	// The email address that you're trying to assign is already created for a different
	// user, group, or resource.
	ErrCodeEmailAddressInUseException = "EmailAddressInUseException"

	// ErrCodeEntityAlreadyRegisteredException for service response error code
	// "EntityAlreadyRegisteredException".
	//
	// The user, group, or resource that you're trying to register is already registered.
	ErrCodeEntityAlreadyRegisteredException = "EntityAlreadyRegisteredException"

	// ErrCodeEntityNotFoundException for service response error code
	// "EntityNotFoundException".
	//
	// The identifier supplied for the user, group, or resource does not exist in
	// your organization.
	ErrCodeEntityNotFoundException = "EntityNotFoundException"

	// ErrCodeEntityStateException for service response error code
	// "EntityStateException".
	//
	// You are performing an operation on a user, group, or resource that isn't
	// in the expected state, such as trying to delete an active user.
	ErrCodeEntityStateException = "EntityStateException"

	// ErrCodeInvalidConfigurationException for service response error code
	// "InvalidConfigurationException".
	//
	// The configuration for a resource isn't valid. A resource must either be able
	// to auto-respond to requests or have at least one delegate associated that
	// can do so on its behalf.
	ErrCodeInvalidConfigurationException = "InvalidConfigurationException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// One or more of the input parameters don't match the service's restrictions.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidPasswordException for service response error code
	// "InvalidPasswordException".
	//
	// The supplied password doesn't match the minimum security constraints, such
	// as length or use of special characters.
	ErrCodeInvalidPasswordException = "InvalidPasswordException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request exceeds the limit of the resource.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMailDomainNotFoundException for service response error code
	// "MailDomainNotFoundException".
	//
	// For an email or alias to be created in Amazon WorkMail, the included domain
	// must be defined in the organization.
	ErrCodeMailDomainNotFoundException = "MailDomainNotFoundException"

	// ErrCodeMailDomainStateException for service response error code
	// "MailDomainStateException".
	//
	// After a domain has been added to the organization, it must be verified. The
	// domain is not yet verified.
	ErrCodeMailDomainStateException = "MailDomainStateException"

	// ErrCodeNameAvailabilityException for service response error code
	// "NameAvailabilityException".
	//
	// The user, group, or resource name isn't unique in Amazon WorkMail.
	ErrCodeNameAvailabilityException = "NameAvailabilityException"

	// ErrCodeOrganizationNotFoundException for service response error code
	// "OrganizationNotFoundException".
	//
	// An operation received a valid organization identifier that either doesn't
	// belong or exist in the system.
	ErrCodeOrganizationNotFoundException = "OrganizationNotFoundException"

	// ErrCodeOrganizationStateException for service response error code
	// "OrganizationStateException".
	//
	// The organization must have a valid state to perform certain operations on
	// the organization or its members.
	ErrCodeOrganizationStateException = "OrganizationStateException"

	// ErrCodeReservedNameException for service response error code
	// "ReservedNameException".
	//
	// This user, group, or resource name is not allowed in Amazon WorkMail.
	ErrCodeReservedNameException = "ReservedNameException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource cannot be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The resource can have up to 50 user-applied tags.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// You can't perform a write operation against a read-only directory.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)
View Source 
const (
	ServiceName = "workmail"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "WorkMail"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AccessControlRuleEffect_Values added in v1.34.3 

func AccessControlRuleEffect_Values() []string

AccessControlRuleEffect_Values returns all elements of the AccessControlRuleEffect enum

func EntityState_Values added in v1.34.3 

func EntityState_Values() []string

EntityState_Values returns all elements of the EntityState enum

func FolderName_Values added in v1.34.3 

func FolderName_Values() []string

FolderName_Values returns all elements of the FolderName enum

func MailboxExportJobState_Values added in v1.34.29 

func MailboxExportJobState_Values() []string

MailboxExportJobState_Values returns all elements of the MailboxExportJobState enum

func MemberType_Values added in v1.34.3 

func MemberType_Values() []string

MemberType_Values returns all elements of the MemberType enum

func MobileDeviceAccessRuleEffect_Values added in v1.38.10 

func MobileDeviceAccessRuleEffect_Values() []string

MobileDeviceAccessRuleEffect_Values returns all elements of the MobileDeviceAccessRuleEffect enum

func PermissionType_Values added in v1.34.3 

func PermissionType_Values() []string

PermissionType_Values returns all elements of the PermissionType enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func RetentionAction_Values added in v1.34.3 

func RetentionAction_Values() []string

RetentionAction_Values returns all elements of the RetentionAction enum

func UserRole_Values added in v1.34.3 

func UserRole_Values() []string

UserRole_Values returns all elements of the UserRole enum

Types

type AccessControlRule added in v1.29.1 

type AccessControlRule struct {

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

	// The date that the rule was created.
	DateCreated *time.Time `type:"timestamp"`

	// The date that the rule was modified.
	DateModified *time.Time `type:"timestamp"`

	// The rule description.
	Description *string `type:"string"`

	// The rule effect.
	Effect *string `type:"string" enum:"AccessControlRuleEffect"`

	// IPv4 CIDR ranges to include in the rule.
	IpRanges []*string `type:"list"`

	// The rule name.
	Name *string `min:"1" type:"string"`

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

	// IPv4 CIDR ranges to exclude from the rule.
	NotIpRanges []*string `type:"list"`

	// User IDs to exclude from the rule.
	NotUserIds []*string `type:"list"`

	// User IDs to include in the rule.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

A rule that controls access to an Amazon WorkMail organization.

func (AccessControlRule) GoString added in v1.29.1 

func (s AccessControlRule) GoString() string

GoString returns the string representation

func (*AccessControlRule) SetActions added in v1.29.1 

func (s *AccessControlRule) SetActions(v []*string) *AccessControlRule

SetActions sets the Actions field's value.

func (*AccessControlRule) SetDateCreated added in v1.29.1 

func (s *AccessControlRule) SetDateCreated(v time.Time) *AccessControlRule

SetDateCreated sets the DateCreated field's value.

func (*AccessControlRule) SetDateModified added in v1.29.1 

func (s *AccessControlRule) SetDateModified(v time.Time) *AccessControlRule

SetDateModified sets the DateModified field's value.

func (*AccessControlRule) SetDescription added in v1.29.1 

func (s *AccessControlRule) SetDescription(v string) *AccessControlRule

SetDescription sets the Description field's value.

func (*AccessControlRule) SetEffect added in v1.29.1 

func (s *AccessControlRule) SetEffect(v string) *AccessControlRule

SetEffect sets the Effect field's value.

func (*AccessControlRule) SetIpRanges added in v1.29.1 

func (s *AccessControlRule) SetIpRanges(v []*string) *AccessControlRule

SetIpRanges sets the IpRanges field's value.

func (*AccessControlRule) SetName added in v1.29.1 

func (s *AccessControlRule) SetName(v string) *AccessControlRule

SetName sets the Name field's value.

func (*AccessControlRule) SetNotActions added in v1.29.1 

func (s *AccessControlRule) SetNotActions(v []*string) *AccessControlRule

SetNotActions sets the NotActions field's value.

func (*AccessControlRule) SetNotIpRanges added in v1.29.1 

func (s *AccessControlRule) SetNotIpRanges(v []*string) *AccessControlRule

SetNotIpRanges sets the NotIpRanges field's value.

func (*AccessControlRule) SetNotUserIds added in v1.29.1 

func (s *AccessControlRule) SetNotUserIds(v []*string) *AccessControlRule

SetNotUserIds sets the NotUserIds field's value.

func (*AccessControlRule) SetUserIds added in v1.29.1 

func (s *AccessControlRule) SetUserIds(v []*string) *AccessControlRule

SetUserIds sets the UserIds field's value.

func (AccessControlRule) String added in v1.29.1 

func (s AccessControlRule) String() string

String returns the string representation

type AssociateDelegateToResourceInput 

type AssociateDelegateToResourceInput struct {

	// The member (user or group) to associate to the resource.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The organization under which the resource exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The resource for which members (users or groups) are associated.
	//
	// ResourceId is a required field
	ResourceId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDelegateToResourceInput) GoString 

func (s AssociateDelegateToResourceInput) GoString() string

GoString returns the string representation

func (*AssociateDelegateToResourceInput) SetEntityId 

func (s *AssociateDelegateToResourceInput) SetEntityId(v string) *AssociateDelegateToResourceInput

SetEntityId sets the EntityId field's value.

func (*AssociateDelegateToResourceInput) SetOrganizationId 

func (s *AssociateDelegateToResourceInput) SetOrganizationId(v string) *AssociateDelegateToResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*AssociateDelegateToResourceInput) SetResourceId 

func (s *AssociateDelegateToResourceInput) SetResourceId(v string) *AssociateDelegateToResourceInput

SetResourceId sets the ResourceId field's value.

func (AssociateDelegateToResourceInput) String 

func (s AssociateDelegateToResourceInput) String() string

String returns the string representation

func (*AssociateDelegateToResourceInput) Validate 

func (s *AssociateDelegateToResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateDelegateToResourceOutput 

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

func (AssociateDelegateToResourceOutput) GoString 

func (s AssociateDelegateToResourceOutput) GoString() string

GoString returns the string representation

func (AssociateDelegateToResourceOutput) String 

func (s AssociateDelegateToResourceOutput) String() string

String returns the string representation

type AssociateMemberToGroupInput 

type AssociateMemberToGroupInput struct {

	// The group to which the member (user or group) is associated.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The member (user or group) to associate to the group.
	//
	// MemberId is a required field
	MemberId *string `min:"12" type:"string" required:"true"`

	// The organization under which the group exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateMemberToGroupInput) GoString 

func (s AssociateMemberToGroupInput) GoString() string

GoString returns the string representation

func (*AssociateMemberToGroupInput) SetGroupId 

func (s *AssociateMemberToGroupInput) SetGroupId(v string) *AssociateMemberToGroupInput

SetGroupId sets the GroupId field's value.

func (*AssociateMemberToGroupInput) SetMemberId 

func (s *AssociateMemberToGroupInput) SetMemberId(v string) *AssociateMemberToGroupInput

SetMemberId sets the MemberId field's value.

func (*AssociateMemberToGroupInput) SetOrganizationId 

func (s *AssociateMemberToGroupInput) SetOrganizationId(v string) *AssociateMemberToGroupInput

SetOrganizationId sets the OrganizationId field's value.

func (AssociateMemberToGroupInput) String 

func (s AssociateMemberToGroupInput) String() string

String returns the string representation

func (*AssociateMemberToGroupInput) Validate 

func (s *AssociateMemberToGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateMemberToGroupOutput 

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

func (AssociateMemberToGroupOutput) GoString 

func (s AssociateMemberToGroupOutput) GoString() string

GoString returns the string representation

func (AssociateMemberToGroupOutput) String 

func (s AssociateMemberToGroupOutput) String() string

String returns the string representation

type BookingOptions 

type BookingOptions struct {

	// The resource's ability to automatically reply to requests. If disabled, delegates
	// must be associated to the resource.
	AutoAcceptRequests *bool `type:"boolean"`

	// The resource's ability to automatically decline any conflicting requests.
	AutoDeclineConflictingRequests *bool `type:"boolean"`

	// The resource's ability to automatically decline any recurring requests.
	AutoDeclineRecurringRequests *bool `type:"boolean"`
	// contains filtered or unexported fields
}

At least one delegate must be associated to the resource to disable automatic replies from the resource.

func (BookingOptions) GoString 

func (s BookingOptions) GoString() string

GoString returns the string representation

func (*BookingOptions) SetAutoAcceptRequests 

func (s *BookingOptions) SetAutoAcceptRequests(v bool) *BookingOptions

SetAutoAcceptRequests sets the AutoAcceptRequests field's value.

func (*BookingOptions) SetAutoDeclineConflictingRequests 

func (s *BookingOptions) SetAutoDeclineConflictingRequests(v bool) *BookingOptions

SetAutoDeclineConflictingRequests sets the AutoDeclineConflictingRequests field's value.

func (*BookingOptions) SetAutoDeclineRecurringRequests 

func (s *BookingOptions) SetAutoDeclineRecurringRequests(v bool) *BookingOptions

SetAutoDeclineRecurringRequests sets the AutoDeclineRecurringRequests field's value.

func (BookingOptions) String 

func (s BookingOptions) String() string

String returns the string representation

type CancelMailboxExportJobInput added in v1.34.29 

type CancelMailboxExportJobInput struct {

	// The idempotency token for the client request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The job ID.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelMailboxExportJobInput) GoString added in v1.34.29 

func (s CancelMailboxExportJobInput) GoString() string

GoString returns the string representation

func (*CancelMailboxExportJobInput) SetClientToken added in v1.34.29 

func (s *CancelMailboxExportJobInput) SetClientToken(v string) *CancelMailboxExportJobInput

SetClientToken sets the ClientToken field's value.

func (*CancelMailboxExportJobInput) SetJobId added in v1.34.29 

func (s *CancelMailboxExportJobInput) SetJobId(v string) *CancelMailboxExportJobInput

SetJobId sets the JobId field's value.

func (*CancelMailboxExportJobInput) SetOrganizationId added in v1.34.29 

func (s *CancelMailboxExportJobInput) SetOrganizationId(v string) *CancelMailboxExportJobInput

SetOrganizationId sets the OrganizationId field's value.

func (CancelMailboxExportJobInput) String added in v1.34.29 

func (s CancelMailboxExportJobInput) String() string

String returns the string representation

func (*CancelMailboxExportJobInput) Validate added in v1.34.29 

func (s *CancelMailboxExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelMailboxExportJobOutput added in v1.34.29 

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

func (CancelMailboxExportJobOutput) GoString added in v1.34.29 

func (s CancelMailboxExportJobOutput) GoString() string

GoString returns the string representation

func (CancelMailboxExportJobOutput) String added in v1.34.29 

func (s CancelMailboxExportJobOutput) String() string

String returns the string representation

type CreateAliasInput 

type CreateAliasInput struct {

	// The alias to add to the member set.
	//
	// Alias is a required field
	Alias *string `min:"1" type:"string" required:"true"`

	// The member (user or group) to which this alias is added.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The organization under which the member (user or group) exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAliasInput) GoString 

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetAlias 

func (s *CreateAliasInput) SetAlias(v string) *CreateAliasInput

SetAlias sets the Alias field's value.

func (*CreateAliasInput) SetEntityId 

func (s *CreateAliasInput) SetEntityId(v string) *CreateAliasInput

SetEntityId sets the EntityId field's value.

func (*CreateAliasInput) SetOrganizationId 

func (s *CreateAliasInput) SetOrganizationId(v string) *CreateAliasInput

SetOrganizationId sets the OrganizationId field's value.

func (CreateAliasInput) String 

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate 

func (s *CreateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAliasOutput 

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

func (CreateAliasOutput) GoString 

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (CreateAliasOutput) String 

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateGroupInput 

type CreateGroupInput struct {

	// The name of the group.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The organization under which the group is to be created.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGroupInput) GoString 

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (*CreateGroupInput) SetName 

func (s *CreateGroupInput) SetName(v string) *CreateGroupInput

SetName sets the Name field's value.

func (*CreateGroupInput) SetOrganizationId 

func (s *CreateGroupInput) SetOrganizationId(v string) *CreateGroupInput

SetOrganizationId sets the OrganizationId field's value.

func (CreateGroupInput) String 

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate 

func (s *CreateGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The identifier of the group.
	GroupId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (CreateGroupOutput) GoString 

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (*CreateGroupOutput) SetGroupId 

func (s *CreateGroupOutput) SetGroupId(v string) *CreateGroupOutput

SetGroupId sets the GroupId field's value.

func (CreateGroupOutput) String 

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateMobileDeviceAccessRuleInput added in v1.38.10 

type CreateMobileDeviceAccessRuleInput struct {

	// The idempotency token for the client request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The rule description.
	Description *string `min:"1" type:"string"`

	// Device models that the rule will match.
	DeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that the rule will match.
	DeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that the rule will match.
	DeviceTypes []*string `min:"1" type:"list"`

	// Device user agents that the rule will match.
	DeviceUserAgents []*string `min:"1" type:"list"`

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY.
	//
	// Effect is a required field
	Effect *string `type:"string" required:"true" enum:"MobileDeviceAccessRuleEffect"`

	// The rule name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Device models that the rule will not match. All other device models will
	// match.
	NotDeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that the rule will not match. All other device operating
	// systems will match.
	NotDeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that the rule will not match. All other device types will match.
	NotDeviceTypes []*string `min:"1" type:"list"`

	// Device user agents that the rule will not match. All other device user agents
	// will match.
	NotDeviceUserAgents []*string `min:"1" type:"list"`

	// The Amazon WorkMail organization under which the rule will be created.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMobileDeviceAccessRuleInput) GoString added in v1.38.10 

func (s CreateMobileDeviceAccessRuleInput) GoString() string

GoString returns the string representation

func (*CreateMobileDeviceAccessRuleInput) SetClientToken added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetClientToken(v string) *CreateMobileDeviceAccessRuleInput

SetClientToken sets the ClientToken field's value.

func (*CreateMobileDeviceAccessRuleInput) SetDescription added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetDescription(v string) *CreateMobileDeviceAccessRuleInput

SetDescription sets the Description field's value.

func (*CreateMobileDeviceAccessRuleInput) SetDeviceModels added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetDeviceModels(v []*string) *CreateMobileDeviceAccessRuleInput

SetDeviceModels sets the DeviceModels field's value.

func (*CreateMobileDeviceAccessRuleInput) SetDeviceOperatingSystems added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetDeviceOperatingSystems(v []*string) *CreateMobileDeviceAccessRuleInput

SetDeviceOperatingSystems sets the DeviceOperatingSystems field's value.

func (*CreateMobileDeviceAccessRuleInput) SetDeviceTypes added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetDeviceTypes(v []*string) *CreateMobileDeviceAccessRuleInput

SetDeviceTypes sets the DeviceTypes field's value.

func (*CreateMobileDeviceAccessRuleInput) SetDeviceUserAgents added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetDeviceUserAgents(v []*string) *CreateMobileDeviceAccessRuleInput

SetDeviceUserAgents sets the DeviceUserAgents field's value.

func (*CreateMobileDeviceAccessRuleInput) SetEffect added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetEffect(v string) *CreateMobileDeviceAccessRuleInput

SetEffect sets the Effect field's value.

func (*CreateMobileDeviceAccessRuleInput) SetName added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetName(v string) *CreateMobileDeviceAccessRuleInput

SetName sets the Name field's value.

func (*CreateMobileDeviceAccessRuleInput) SetNotDeviceModels added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetNotDeviceModels(v []*string) *CreateMobileDeviceAccessRuleInput

SetNotDeviceModels sets the NotDeviceModels field's value.

func (*CreateMobileDeviceAccessRuleInput) SetNotDeviceOperatingSystems added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetNotDeviceOperatingSystems(v []*string) *CreateMobileDeviceAccessRuleInput

SetNotDeviceOperatingSystems sets the NotDeviceOperatingSystems field's value.

func (*CreateMobileDeviceAccessRuleInput) SetNotDeviceTypes added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetNotDeviceTypes(v []*string) *CreateMobileDeviceAccessRuleInput

SetNotDeviceTypes sets the NotDeviceTypes field's value.

func (*CreateMobileDeviceAccessRuleInput) SetNotDeviceUserAgents added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetNotDeviceUserAgents(v []*string) *CreateMobileDeviceAccessRuleInput

SetNotDeviceUserAgents sets the NotDeviceUserAgents field's value.

func (*CreateMobileDeviceAccessRuleInput) SetOrganizationId added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) SetOrganizationId(v string) *CreateMobileDeviceAccessRuleInput

SetOrganizationId sets the OrganizationId field's value.

func (CreateMobileDeviceAccessRuleInput) String added in v1.38.10 

func (s CreateMobileDeviceAccessRuleInput) String() string

String returns the string representation

func (*CreateMobileDeviceAccessRuleInput) Validate added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMobileDeviceAccessRuleOutput added in v1.38.10 

type CreateMobileDeviceAccessRuleOutput struct {

	// The identifier for the newly created mobile device access rule.
	MobileDeviceAccessRuleId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateMobileDeviceAccessRuleOutput) GoString added in v1.38.10 

func (s CreateMobileDeviceAccessRuleOutput) GoString() string

GoString returns the string representation

func (*CreateMobileDeviceAccessRuleOutput) SetMobileDeviceAccessRuleId added in v1.38.10 

func (s *CreateMobileDeviceAccessRuleOutput) SetMobileDeviceAccessRuleId(v string) *CreateMobileDeviceAccessRuleOutput

SetMobileDeviceAccessRuleId sets the MobileDeviceAccessRuleId field's value.

func (CreateMobileDeviceAccessRuleOutput) String added in v1.38.10 

func (s CreateMobileDeviceAccessRuleOutput) String() string

String returns the string representation

type CreateOrganizationInput added in v1.35.8 

type CreateOrganizationInput struct {

	// The organization alias.
	//
	// Alias is a required field
	Alias *string `min:"1" type:"string" required:"true"`

	// The idempotency token associated with the request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The AWS Directory Service directory ID.
	DirectoryId *string `min:"12" type:"string"`

	// The email domains to associate with the organization.
	Domains []*Domain `type:"list"`

	// When true, allows organization interoperability between Amazon WorkMail and
	// Microsoft Exchange. Can only be set to true if an AD Connector directory
	// ID is included in the request.
	EnableInteroperability *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of a customer managed master key from AWS
	// KMS.
	KmsKeyArn *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreateOrganizationInput) GoString added in v1.35.8 

func (s CreateOrganizationInput) GoString() string

GoString returns the string representation

func (*CreateOrganizationInput) SetAlias added in v1.35.8 

func (s *CreateOrganizationInput) SetAlias(v string) *CreateOrganizationInput

SetAlias sets the Alias field's value.

func (*CreateOrganizationInput) SetClientToken added in v1.35.8 

func (s *CreateOrganizationInput) SetClientToken(v string) *CreateOrganizationInput

SetClientToken sets the ClientToken field's value.

func (*CreateOrganizationInput) SetDirectoryId added in v1.35.8 

func (s *CreateOrganizationInput) SetDirectoryId(v string) *CreateOrganizationInput

SetDirectoryId sets the DirectoryId field's value.

func (*CreateOrganizationInput) SetDomains added in v1.35.8 

func (s *CreateOrganizationInput) SetDomains(v []*Domain) *CreateOrganizationInput

SetDomains sets the Domains field's value.

func (*CreateOrganizationInput) SetEnableInteroperability added in v1.35.8 

func (s *CreateOrganizationInput) SetEnableInteroperability(v bool) *CreateOrganizationInput

SetEnableInteroperability sets the EnableInteroperability field's value.

func (*CreateOrganizationInput) SetKmsKeyArn added in v1.35.8 

func (s *CreateOrganizationInput) SetKmsKeyArn(v string) *CreateOrganizationInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (CreateOrganizationInput) String added in v1.35.8 

func (s CreateOrganizationInput) String() string

String returns the string representation

func (*CreateOrganizationInput) Validate added in v1.35.8 

func (s *CreateOrganizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateOrganizationOutput added in v1.35.8 

type CreateOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string `min:"34" type:"string"`
	// contains filtered or unexported fields
}

func (CreateOrganizationOutput) GoString added in v1.35.8 

func (s CreateOrganizationOutput) GoString() string

GoString returns the string representation

func (*CreateOrganizationOutput) SetOrganizationId added in v1.35.8 

func (s *CreateOrganizationOutput) SetOrganizationId(v string) *CreateOrganizationOutput

SetOrganizationId sets the OrganizationId field's value.

func (CreateOrganizationOutput) String added in v1.35.8 

func (s CreateOrganizationOutput) String() string

String returns the string representation

type CreateResourceInput 

type CreateResourceInput struct {

	// The name of the new resource.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The identifier associated with the organization for which the resource is
	// created.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The type of the new resource. The available types are equipment and room.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (CreateResourceInput) GoString 

func (s CreateResourceInput) GoString() string

GoString returns the string representation

func (*CreateResourceInput) SetName 

func (s *CreateResourceInput) SetName(v string) *CreateResourceInput

SetName sets the Name field's value.

func (*CreateResourceInput) SetOrganizationId 

func (s *CreateResourceInput) SetOrganizationId(v string) *CreateResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*CreateResourceInput) SetType 

func (s *CreateResourceInput) SetType(v string) *CreateResourceInput

SetType sets the Type field's value.

func (CreateResourceInput) String 

func (s CreateResourceInput) String() string

String returns the string representation

func (*CreateResourceInput) Validate 

func (s *CreateResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateResourceOutput 

type CreateResourceOutput struct {

	// The identifier of the new resource.
	ResourceId *string `min:"34" type:"string"`
	// contains filtered or unexported fields
}

func (CreateResourceOutput) GoString 

func (s CreateResourceOutput) GoString() string

GoString returns the string representation

func (*CreateResourceOutput) SetResourceId 

func (s *CreateResourceOutput) SetResourceId(v string) *CreateResourceOutput

SetResourceId sets the ResourceId field's value.

func (CreateResourceOutput) String 

func (s CreateResourceOutput) String() string

String returns the string representation

type CreateUserInput 

type CreateUserInput struct {

	// The display name for the new user.
	//
	// DisplayName is a required field
	DisplayName *string `type:"string" required:"true"`

	// The name for the new user. WorkMail directory user names have a maximum length
	// of 64. All others have a maximum length of 20.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The identifier of the organization for which the user is created.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The password for the new user.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetDisplayName 

func (s *CreateUserInput) SetDisplayName(v string) *CreateUserInput

SetDisplayName sets the DisplayName field's value.

func (*CreateUserInput) SetName 

func (s *CreateUserInput) SetName(v string) *CreateUserInput

SetName sets the Name field's value.

func (*CreateUserInput) SetOrganizationId 

func (s *CreateUserInput) SetOrganizationId(v string) *CreateUserInput

SetOrganizationId sets the OrganizationId field's value.

func (*CreateUserInput) SetPassword 

func (s *CreateUserInput) SetPassword(v string) *CreateUserInput

SetPassword sets the Password field's value.

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput 

type CreateUserOutput struct {

	// The identifier for the new user.
	UserId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (*CreateUserOutput) SetUserId 

func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput

SetUserId sets the UserId field's value.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation

type Delegate 

type Delegate struct {

	// The identifier for the user or group associated as the resource's delegate.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The type of the delegate: user or group.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"MemberType"`
	// contains filtered or unexported fields
}

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

func (Delegate) GoString 

func (s Delegate) GoString() string

GoString returns the string representation

func (*Delegate) SetId 

func (s *Delegate) SetId(v string) *Delegate

SetId sets the Id field's value.

func (*Delegate) SetType 

func (s *Delegate) SetType(v string) *Delegate

SetType sets the Type field's value.

func (Delegate) String 

func (s Delegate) String() string

String returns the string representation

type DeleteAccessControlRuleInput added in v1.29.1 

type DeleteAccessControlRuleInput struct {

	// The name of the access control rule.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The identifier for the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessControlRuleInput) GoString added in v1.29.1 

func (s DeleteAccessControlRuleInput) GoString() string

GoString returns the string representation

func (*DeleteAccessControlRuleInput) SetName added in v1.29.1 

func (s *DeleteAccessControlRuleInput) SetName(v string) *DeleteAccessControlRuleInput

SetName sets the Name field's value.

func (*DeleteAccessControlRuleInput) SetOrganizationId added in v1.29.1 

func (s *DeleteAccessControlRuleInput) SetOrganizationId(v string) *DeleteAccessControlRuleInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteAccessControlRuleInput) String added in v1.29.1 

func (s DeleteAccessControlRuleInput) String() string

String returns the string representation

func (*DeleteAccessControlRuleInput) Validate added in v1.29.1 

func (s *DeleteAccessControlRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessControlRuleOutput added in v1.29.1 

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

func (DeleteAccessControlRuleOutput) GoString added in v1.29.1 

func (s DeleteAccessControlRuleOutput) GoString() string

GoString returns the string representation

func (DeleteAccessControlRuleOutput) String added in v1.29.1 

func (s DeleteAccessControlRuleOutput) String() string

String returns the string representation

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).
	//
	// Alias is a required field
	Alias *string `min:"1" type:"string" required:"true"`

	// The identifier for the member (user or group) from which to have the aliases
	// removed.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the user exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAliasInput) GoString 

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (*DeleteAliasInput) SetAlias 

func (s *DeleteAliasInput) SetAlias(v string) *DeleteAliasInput

SetAlias sets the Alias field's value.

func (*DeleteAliasInput) SetEntityId 

func (s *DeleteAliasInput) SetEntityId(v string) *DeleteAliasInput

SetEntityId sets the EntityId field's value.

func (*DeleteAliasInput) SetOrganizationId 

func (s *DeleteAliasInput) SetOrganizationId(v string) *DeleteAliasInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteAliasInput) String 

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate 

func (s *DeleteAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAliasOutput 

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

func (DeleteAliasOutput) GoString 

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) String 

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The identifier of the group to be deleted.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The organization that contains the group.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGroupInput) GoString 

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (*DeleteGroupInput) SetGroupId 

func (s *DeleteGroupInput) SetGroupId(v string) *DeleteGroupInput

SetGroupId sets the GroupId field's value.

func (*DeleteGroupInput) SetOrganizationId 

func (s *DeleteGroupInput) SetOrganizationId(v string) *DeleteGroupInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteGroupInput) String 

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate 

func (s *DeleteGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGroupOutput 

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

func (DeleteGroupOutput) GoString 

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) String 

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteMailboxPermissionsInput added in v1.13.32 

type DeleteMailboxPermissionsInput struct {

	// The identifier of the member (user or group) that owns the mailbox.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier of the member (user or group) for which to delete granted
	// permissions.
	//
	// GranteeId is a required field
	GranteeId *string `min:"12" type:"string" required:"true"`

	// The identifier of the organization under which the member (user or group)
	// exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMailboxPermissionsInput) GoString added in v1.13.32 

func (s DeleteMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*DeleteMailboxPermissionsInput) SetEntityId added in v1.13.32 

func (s *DeleteMailboxPermissionsInput) SetEntityId(v string) *DeleteMailboxPermissionsInput

SetEntityId sets the EntityId field's value.

func (*DeleteMailboxPermissionsInput) SetGranteeId added in v1.13.32 

func (s *DeleteMailboxPermissionsInput) SetGranteeId(v string) *DeleteMailboxPermissionsInput

SetGranteeId sets the GranteeId field's value.

func (*DeleteMailboxPermissionsInput) SetOrganizationId added in v1.13.32 

func (s *DeleteMailboxPermissionsInput) SetOrganizationId(v string) *DeleteMailboxPermissionsInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteMailboxPermissionsInput) String added in v1.13.32 

func (s DeleteMailboxPermissionsInput) String() string

String returns the string representation

func (*DeleteMailboxPermissionsInput) Validate added in v1.13.32 

func (s *DeleteMailboxPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMailboxPermissionsOutput added in v1.13.32 

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

func (DeleteMailboxPermissionsOutput) GoString added in v1.13.32 

func (s DeleteMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (DeleteMailboxPermissionsOutput) String added in v1.13.32 

func (s DeleteMailboxPermissionsOutput) String() string

String returns the string representation

type DeleteMobileDeviceAccessRuleInput added in v1.38.10 

type DeleteMobileDeviceAccessRuleInput struct {

	// The identifier of the rule to be deleted.
	//
	// MobileDeviceAccessRuleId is a required field
	MobileDeviceAccessRuleId *string `min:"1" type:"string" required:"true"`

	// The Amazon WorkMail organization under which the rule will be deleted.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMobileDeviceAccessRuleInput) GoString added in v1.38.10 

func (s DeleteMobileDeviceAccessRuleInput) GoString() string

GoString returns the string representation

func (*DeleteMobileDeviceAccessRuleInput) SetMobileDeviceAccessRuleId added in v1.38.10 

func (s *DeleteMobileDeviceAccessRuleInput) SetMobileDeviceAccessRuleId(v string) *DeleteMobileDeviceAccessRuleInput

SetMobileDeviceAccessRuleId sets the MobileDeviceAccessRuleId field's value.

func (*DeleteMobileDeviceAccessRuleInput) SetOrganizationId added in v1.38.10 

func (s *DeleteMobileDeviceAccessRuleInput) SetOrganizationId(v string) *DeleteMobileDeviceAccessRuleInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteMobileDeviceAccessRuleInput) String added in v1.38.10 

func (s DeleteMobileDeviceAccessRuleInput) String() string

String returns the string representation

func (*DeleteMobileDeviceAccessRuleInput) Validate added in v1.38.10 

func (s *DeleteMobileDeviceAccessRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMobileDeviceAccessRuleOutput added in v1.38.10 

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

func (DeleteMobileDeviceAccessRuleOutput) GoString added in v1.38.10 

func (s DeleteMobileDeviceAccessRuleOutput) GoString() string

GoString returns the string representation

func (DeleteMobileDeviceAccessRuleOutput) String added in v1.38.10 

func (s DeleteMobileDeviceAccessRuleOutput) String() string

String returns the string representation

type DeleteOrganizationInput added in v1.35.8 

type DeleteOrganizationInput struct {

	// The idempotency token associated with the request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// If true, deletes the AWS Directory Service directory associated with the
	// organization.
	//
	// DeleteDirectory is a required field
	DeleteDirectory *bool `type:"boolean" required:"true"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteOrganizationInput) GoString added in v1.35.8 

func (s DeleteOrganizationInput) GoString() string

GoString returns the string representation

func (*DeleteOrganizationInput) SetClientToken added in v1.35.8 

func (s *DeleteOrganizationInput) SetClientToken(v string) *DeleteOrganizationInput

SetClientToken sets the ClientToken field's value.

func (*DeleteOrganizationInput) SetDeleteDirectory added in v1.35.8 

func (s *DeleteOrganizationInput) SetDeleteDirectory(v bool) *DeleteOrganizationInput

SetDeleteDirectory sets the DeleteDirectory field's value.

func (*DeleteOrganizationInput) SetOrganizationId added in v1.35.8 

func (s *DeleteOrganizationInput) SetOrganizationId(v string) *DeleteOrganizationInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteOrganizationInput) String added in v1.35.8 

func (s DeleteOrganizationInput) String() string

String returns the string representation

func (*DeleteOrganizationInput) Validate added in v1.35.8 

func (s *DeleteOrganizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteOrganizationOutput added in v1.35.8 

type DeleteOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string `min:"34" type:"string"`

	// The state of the organization.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteOrganizationOutput) GoString added in v1.35.8 

func (s DeleteOrganizationOutput) GoString() string

GoString returns the string representation

func (*DeleteOrganizationOutput) SetOrganizationId added in v1.35.8 

func (s *DeleteOrganizationOutput) SetOrganizationId(v string) *DeleteOrganizationOutput

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteOrganizationOutput) SetState added in v1.35.8 

func (s *DeleteOrganizationOutput) SetState(v string) *DeleteOrganizationOutput

SetState sets the State field's value.

func (DeleteOrganizationOutput) String added in v1.35.8 

func (s DeleteOrganizationOutput) String() string

String returns the string representation

type DeleteResourceInput 

type DeleteResourceInput struct {

	// The identifier associated with the organization from which the resource is
	// deleted.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier of the resource to be deleted.
	//
	// ResourceId is a required field
	ResourceId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourceInput) GoString 

func (s DeleteResourceInput) GoString() string

GoString returns the string representation

func (*DeleteResourceInput) SetOrganizationId 

func (s *DeleteResourceInput) SetOrganizationId(v string) *DeleteResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteResourceInput) SetResourceId 

func (s *DeleteResourceInput) SetResourceId(v string) *DeleteResourceInput

SetResourceId sets the ResourceId field's value.

func (DeleteResourceInput) String 

func (s DeleteResourceInput) String() string

String returns the string representation

func (*DeleteResourceInput) Validate 

func (s *DeleteResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteResourceOutput 

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

func (DeleteResourceOutput) GoString 

func (s DeleteResourceOutput) GoString() string

GoString returns the string representation

func (DeleteResourceOutput) String 

func (s DeleteResourceOutput) String() string

String returns the string representation

type DeleteRetentionPolicyInput added in v1.31.7 

type DeleteRetentionPolicyInput struct {

	// The retention policy ID.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRetentionPolicyInput) GoString added in v1.31.7 

func (s DeleteRetentionPolicyInput) GoString() string

GoString returns the string representation

func (*DeleteRetentionPolicyInput) SetId added in v1.31.7 

func (s *DeleteRetentionPolicyInput) SetId(v string) *DeleteRetentionPolicyInput

SetId sets the Id field's value.

func (*DeleteRetentionPolicyInput) SetOrganizationId added in v1.31.7 

func (s *DeleteRetentionPolicyInput) SetOrganizationId(v string) *DeleteRetentionPolicyInput

SetOrganizationId sets the OrganizationId field's value.

func (DeleteRetentionPolicyInput) String added in v1.31.7 

func (s DeleteRetentionPolicyInput) String() string

String returns the string representation

func (*DeleteRetentionPolicyInput) Validate added in v1.31.7 

func (s *DeleteRetentionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRetentionPolicyOutput added in v1.31.7 

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

func (DeleteRetentionPolicyOutput) GoString added in v1.31.7 

func (s DeleteRetentionPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteRetentionPolicyOutput) String added in v1.31.7 

func (s DeleteRetentionPolicyOutput) String() string

String returns the string representation

type DeleteUserInput 

type DeleteUserInput struct {

	// The organization that contains the user to be deleted.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier of the user to be deleted.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetOrganizationId 

func (s *DeleteUserInput) SetOrganizationId(v string) *DeleteUserInput

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteUserInput) SetUserId 

func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput

SetUserId sets the UserId field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput 

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

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DeregisterFromWorkMailInput 

type DeregisterFromWorkMailInput struct {

	// The identifier for the member (user or group) to be updated.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the Amazon WorkMail entity
	// exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterFromWorkMailInput) GoString 

func (s DeregisterFromWorkMailInput) GoString() string

GoString returns the string representation

func (*DeregisterFromWorkMailInput) SetEntityId 

func (s *DeregisterFromWorkMailInput) SetEntityId(v string) *DeregisterFromWorkMailInput

SetEntityId sets the EntityId field's value.

func (*DeregisterFromWorkMailInput) SetOrganizationId 

func (s *DeregisterFromWorkMailInput) SetOrganizationId(v string) *DeregisterFromWorkMailInput

SetOrganizationId sets the OrganizationId field's value.

func (DeregisterFromWorkMailInput) String 

func (s DeregisterFromWorkMailInput) String() string

String returns the string representation

func (*DeregisterFromWorkMailInput) Validate 

func (s *DeregisterFromWorkMailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterFromWorkMailOutput 

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

func (DeregisterFromWorkMailOutput) GoString 

func (s DeregisterFromWorkMailOutput) GoString() string

GoString returns the string representation

func (DeregisterFromWorkMailOutput) String 

func (s DeregisterFromWorkMailOutput) String() string

String returns the string representation

type DescribeGroupInput 

type DescribeGroupInput struct {

	// The identifier for the group to be described.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the group exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGroupInput) GoString 

func (s DescribeGroupInput) GoString() string

GoString returns the string representation

func (*DescribeGroupInput) SetGroupId 

func (s *DescribeGroupInput) SetGroupId(v string) *DescribeGroupInput

SetGroupId sets the GroupId field's value.

func (*DescribeGroupInput) SetOrganizationId 

func (s *DescribeGroupInput) SetOrganizationId(v string) *DescribeGroupInput

SetOrganizationId sets the OrganizationId field's value.

func (DescribeGroupInput) String 

func (s DescribeGroupInput) String() string

String returns the string representation

func (*DescribeGroupInput) Validate 

func (s *DescribeGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGroupOutput 

type DescribeGroupOutput struct {

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

	// The email of the described group.
	Email *string `min:"1" type:"string"`

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

	// The identifier of the described group.
	GroupId *string `min:"12" type:"string"`

	// The name of the described group.
	Name *string `min:"1" type:"string"`

	// The state of the user: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State *string `type:"string" enum:"EntityState"`
	// contains filtered or unexported fields
}

func (DescribeGroupOutput) GoString 

func (s DescribeGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeGroupOutput) SetDisabledDate 

func (s *DescribeGroupOutput) SetDisabledDate(v time.Time) *DescribeGroupOutput

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeGroupOutput) SetEmail 

func (s *DescribeGroupOutput) SetEmail(v string) *DescribeGroupOutput

SetEmail sets the Email field's value.

func (*DescribeGroupOutput) SetEnabledDate 

func (s *DescribeGroupOutput) SetEnabledDate(v time.Time) *DescribeGroupOutput

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeGroupOutput) SetGroupId 

func (s *DescribeGroupOutput) SetGroupId(v string) *DescribeGroupOutput

SetGroupId sets the GroupId field's value.

func (*DescribeGroupOutput) SetName 

func (s *DescribeGroupOutput) SetName(v string) *DescribeGroupOutput

SetName sets the Name field's value.

func (*DescribeGroupOutput) SetState 

func (s *DescribeGroupOutput) SetState(v string) *DescribeGroupOutput

SetState sets the State field's value.

func (DescribeGroupOutput) String 

func (s DescribeGroupOutput) String() string

String returns the string representation

type DescribeMailboxExportJobInput added in v1.34.29 

type DescribeMailboxExportJobInput struct {

	// The mailbox export job ID.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMailboxExportJobInput) GoString added in v1.34.29 

func (s DescribeMailboxExportJobInput) GoString() string

GoString returns the string representation

func (*DescribeMailboxExportJobInput) SetJobId added in v1.34.29 

func (s *DescribeMailboxExportJobInput) SetJobId(v string) *DescribeMailboxExportJobInput

SetJobId sets the JobId field's value.

func (*DescribeMailboxExportJobInput) SetOrganizationId added in v1.34.29 

func (s *DescribeMailboxExportJobInput) SetOrganizationId(v string) *DescribeMailboxExportJobInput

SetOrganizationId sets the OrganizationId field's value.

func (DescribeMailboxExportJobInput) String added in v1.34.29 

func (s DescribeMailboxExportJobInput) String() string

String returns the string representation

func (*DescribeMailboxExportJobInput) Validate added in v1.34.29 

func (s *DescribeMailboxExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMailboxExportJobOutput added in v1.34.29 

type DescribeMailboxExportJobOutput struct {

	// The mailbox export job description.
	Description *string `type:"string"`

	// The mailbox export job end timestamp.
	EndTime *time.Time `type:"timestamp"`

	// The identifier of the user or resource associated with the mailbox.
	EntityId *string `min:"12" type:"string"`

	// Error information for failed mailbox export jobs.
	ErrorInfo *string `min:"1" type:"string"`

	// The estimated progress of the mailbox export job, in percentage points.
	EstimatedProgress *int64 `type:"integer"`

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

	// The name of the S3 bucket.
	S3BucketName *string `min:"1" type:"string"`

	// The path to the S3 bucket and file that the mailbox export job is exporting
	// to.
	S3Path *string `min:"1" type:"string"`

	// The S3 bucket prefix.
	S3Prefix *string `min:"1" type:"string"`

	// The mailbox export job start timestamp.
	StartTime *time.Time `type:"timestamp"`

	// The state of the mailbox export job.
	State *string `type:"string" enum:"MailboxExportJobState"`
	// contains filtered or unexported fields
}

func (DescribeMailboxExportJobOutput) GoString added in v1.34.29 

func (s DescribeMailboxExportJobOutput) GoString() string

GoString returns the string representation

func (*DescribeMailboxExportJobOutput) SetDescription added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetDescription(v string) *DescribeMailboxExportJobOutput

SetDescription sets the Description field's value.

func (*DescribeMailboxExportJobOutput) SetEndTime added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetEndTime(v time.Time) *DescribeMailboxExportJobOutput

SetEndTime sets the EndTime field's value.

func (*DescribeMailboxExportJobOutput) SetEntityId added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetEntityId(v string) *DescribeMailboxExportJobOutput

SetEntityId sets the EntityId field's value.

func (*DescribeMailboxExportJobOutput) SetErrorInfo added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetErrorInfo(v string) *DescribeMailboxExportJobOutput

SetErrorInfo sets the ErrorInfo field's value.

func (*DescribeMailboxExportJobOutput) SetEstimatedProgress added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetEstimatedProgress(v int64) *DescribeMailboxExportJobOutput

SetEstimatedProgress sets the EstimatedProgress field's value.

func (*DescribeMailboxExportJobOutput) SetKmsKeyArn added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetKmsKeyArn(v string) *DescribeMailboxExportJobOutput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*DescribeMailboxExportJobOutput) SetRoleArn added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetRoleArn(v string) *DescribeMailboxExportJobOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeMailboxExportJobOutput) SetS3BucketName added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetS3BucketName(v string) *DescribeMailboxExportJobOutput

SetS3BucketName sets the S3BucketName field's value.

func (*DescribeMailboxExportJobOutput) SetS3Path added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetS3Path(v string) *DescribeMailboxExportJobOutput

SetS3Path sets the S3Path field's value.

func (*DescribeMailboxExportJobOutput) SetS3Prefix added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetS3Prefix(v string) *DescribeMailboxExportJobOutput

SetS3Prefix sets the S3Prefix field's value.

func (*DescribeMailboxExportJobOutput) SetStartTime added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetStartTime(v time.Time) *DescribeMailboxExportJobOutput

SetStartTime sets the StartTime field's value.

func (*DescribeMailboxExportJobOutput) SetState added in v1.34.29 

func (s *DescribeMailboxExportJobOutput) SetState(v string) *DescribeMailboxExportJobOutput

SetState sets the State field's value.

func (DescribeMailboxExportJobOutput) String added in v1.34.29 

func (s DescribeMailboxExportJobOutput) String() string

String returns the string representation

type DescribeOrganizationInput 

type DescribeOrganizationInput struct {

	// The identifier for the organization to be described.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationInput) GoString 

func (s DescribeOrganizationInput) GoString() string

GoString returns the string representation

func (*DescribeOrganizationInput) SetOrganizationId 

func (s *DescribeOrganizationInput) SetOrganizationId(v string) *DescribeOrganizationInput

SetOrganizationId sets the OrganizationId field's value.

func (DescribeOrganizationInput) String 

func (s DescribeOrganizationInput) String() string

String returns the string representation

func (*DescribeOrganizationInput) Validate 

func (s *DescribeOrganizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeOrganizationOutput 

type DescribeOrganizationOutput struct {

	// The Amazon Resource Name (ARN) of the organization.
	ARN *string `min:"1" type:"string"`

	// The alias for an organization.
	Alias *string `min:"1" type:"string"`

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

	// The default mail domain associated with the organization.
	DefaultMailDomain *string `type:"string"`

	// The identifier for the directory associated with an Amazon WorkMail organization.
	DirectoryId *string `type:"string"`

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

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

	// The identifier of an organization.
	OrganizationId *string `min:"34" type:"string"`

	// The state of an organization.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationOutput) GoString 

func (s DescribeOrganizationOutput) GoString() string

GoString returns the string representation

func (*DescribeOrganizationOutput) SetARN added in v1.28.10 

func (s *DescribeOrganizationOutput) SetARN(v string) *DescribeOrganizationOutput

SetARN sets the ARN field's value.

func (*DescribeOrganizationOutput) SetAlias 

func (s *DescribeOrganizationOutput) SetAlias(v string) *DescribeOrganizationOutput

SetAlias sets the Alias field's value.

func (*DescribeOrganizationOutput) SetCompletedDate 

func (s *DescribeOrganizationOutput) SetCompletedDate(v time.Time) *DescribeOrganizationOutput

SetCompletedDate sets the CompletedDate field's value.

func (*DescribeOrganizationOutput) SetDefaultMailDomain 

func (s *DescribeOrganizationOutput) SetDefaultMailDomain(v string) *DescribeOrganizationOutput

SetDefaultMailDomain sets the DefaultMailDomain field's value.

func (*DescribeOrganizationOutput) SetDirectoryId 

func (s *DescribeOrganizationOutput) SetDirectoryId(v string) *DescribeOrganizationOutput

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeOrganizationOutput) SetDirectoryType 

func (s *DescribeOrganizationOutput) SetDirectoryType(v string) *DescribeOrganizationOutput

SetDirectoryType sets the DirectoryType field's value.

func (*DescribeOrganizationOutput) SetErrorMessage 

func (s *DescribeOrganizationOutput) SetErrorMessage(v string) *DescribeOrganizationOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeOrganizationOutput) SetOrganizationId 

func (s *DescribeOrganizationOutput) SetOrganizationId(v string) *DescribeOrganizationOutput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeOrganizationOutput) SetState 

func (s *DescribeOrganizationOutput) SetState(v string) *DescribeOrganizationOutput

SetState sets the State field's value.

func (DescribeOrganizationOutput) String 

func (s DescribeOrganizationOutput) String() string

String returns the string representation

type DescribeResourceInput 

type DescribeResourceInput struct {

	// The identifier associated with the organization for which the resource is
	// described.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier of the resource to be described.
	//
	// ResourceId is a required field
	ResourceId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeResourceInput) GoString 

func (s DescribeResourceInput) GoString() string

GoString returns the string representation

func (*DescribeResourceInput) SetOrganizationId 

func (s *DescribeResourceInput) SetOrganizationId(v string) *DescribeResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeResourceInput) SetResourceId 

func (s *DescribeResourceInput) SetResourceId(v string) *DescribeResourceInput

SetResourceId sets the ResourceId field's value.

func (DescribeResourceInput) String 

func (s DescribeResourceInput) String() string

String returns the string representation

func (*DescribeResourceInput) Validate 

func (s *DescribeResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourceOutput 

type DescribeResourceOutput struct {

	// The booking options for the described resource.
	BookingOptions *BookingOptions `type:"structure"`

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

	// The email of the described resource.
	Email *string `min:"1" type:"string"`

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

	// The name of the described resource.
	Name *string `min:"1" type:"string"`

	// The identifier of the described resource.
	ResourceId *string `min:"34" type:"string"`

	// The state of the resource: enabled (registered to Amazon WorkMail), disabled
	// (deregistered or never registered to WorkMail), or deleted.
	State *string `type:"string" enum:"EntityState"`

	// The type of the described resource.
	Type *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (DescribeResourceOutput) GoString 

func (s DescribeResourceOutput) GoString() string

GoString returns the string representation

func (*DescribeResourceOutput) SetBookingOptions 

func (s *DescribeResourceOutput) SetBookingOptions(v *BookingOptions) *DescribeResourceOutput

SetBookingOptions sets the BookingOptions field's value.

func (*DescribeResourceOutput) SetDisabledDate 

func (s *DescribeResourceOutput) SetDisabledDate(v time.Time) *DescribeResourceOutput

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeResourceOutput) SetEmail 

func (s *DescribeResourceOutput) SetEmail(v string) *DescribeResourceOutput

SetEmail sets the Email field's value.

func (*DescribeResourceOutput) SetEnabledDate 

func (s *DescribeResourceOutput) SetEnabledDate(v time.Time) *DescribeResourceOutput

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeResourceOutput) SetName 

func (s *DescribeResourceOutput) SetName(v string) *DescribeResourceOutput

SetName sets the Name field's value.

func (*DescribeResourceOutput) SetResourceId 

func (s *DescribeResourceOutput) SetResourceId(v string) *DescribeResourceOutput

SetResourceId sets the ResourceId field's value.

func (*DescribeResourceOutput) SetState 

func (s *DescribeResourceOutput) SetState(v string) *DescribeResourceOutput

SetState sets the State field's value.

func (*DescribeResourceOutput) SetType 

func (s *DescribeResourceOutput) SetType(v string) *DescribeResourceOutput

SetType sets the Type field's value.

func (DescribeResourceOutput) String 

func (s DescribeResourceOutput) String() string

String returns the string representation

type DescribeUserInput 

type DescribeUserInput struct {

	// The identifier for the organization under which the user exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier for the user to be described.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserInput) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetOrganizationId 

func (s *DescribeUserInput) SetOrganizationId(v string) *DescribeUserInput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeUserInput) SetUserId 

func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput

SetUserId sets the UserId field's value.

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate 

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput 

type DescribeUserOutput struct {

	// The date and time at which the user was disabled for Amazon WorkMail usage,
	// in UNIX epoch time format.
	DisabledDate *time.Time `type:"timestamp"`

	// The display name of the user.
	DisplayName *string `type:"string"`

	// The email of the user.
	Email *string `min:"1" type:"string"`

	// The date and time at which the user was enabled for Amazon WorkMail usage,
	// in UNIX epoch time format.
	EnabledDate *time.Time `type:"timestamp"`

	// The name for the user.
	Name *string `min:"1" type:"string"`

	// The state of a user: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State *string `type:"string" enum:"EntityState"`

	// The identifier for the described user.
	UserId *string `min:"12" type:"string"`

	// In certain cases, other entities are modeled as users. If interoperability
	// is enabled, resources are imported into Amazon WorkMail as users. Because
	// different WorkMail organizations rely on different directory types, administrators
	// can distinguish between an unregistered user (account is disabled and has
	// a user role) and the directory administrators. The values are USER, RESOURCE,
	// and SYSTEM_USER.
	UserRole *string `type:"string" enum:"UserRole"`
	// contains filtered or unexported fields
}

func (DescribeUserOutput) GoString 

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetDisabledDate 

func (s *DescribeUserOutput) SetDisabledDate(v time.Time) *DescribeUserOutput

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeUserOutput) SetDisplayName 

func (s *DescribeUserOutput) SetDisplayName(v string) *DescribeUserOutput

SetDisplayName sets the DisplayName field's value.

func (*DescribeUserOutput) SetEmail 

func (s *DescribeUserOutput) SetEmail(v string) *DescribeUserOutput

SetEmail sets the Email field's value.

func (*DescribeUserOutput) SetEnabledDate 

func (s *DescribeUserOutput) SetEnabledDate(v time.Time) *DescribeUserOutput

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeUserOutput) SetName 

func (s *DescribeUserOutput) SetName(v string) *DescribeUserOutput

SetName sets the Name field's value.

func (*DescribeUserOutput) SetState 

func (s *DescribeUserOutput) SetState(v string) *DescribeUserOutput

SetState sets the State field's value.

func (*DescribeUserOutput) SetUserId 

func (s *DescribeUserOutput) SetUserId(v string) *DescribeUserOutput

SetUserId sets the UserId field's value.

func (*DescribeUserOutput) SetUserRole 

func (s *DescribeUserOutput) SetUserRole(v string) *DescribeUserOutput

SetUserRole sets the UserRole field's value.

func (DescribeUserOutput) String 

func (s DescribeUserOutput) String() string

String returns the string representation

type DirectoryInUseException added in v1.35.8 

type DirectoryInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The directory is already in use by another WorkMail organization in the same account and Region.

func (*DirectoryInUseException) Code added in v1.35.8 

func (s *DirectoryInUseException) Code() string

Code returns the exception type name.

func (*DirectoryInUseException) Error added in v1.35.8 

func (s *DirectoryInUseException) Error() string

func (DirectoryInUseException) GoString added in v1.35.8 

func (s DirectoryInUseException) GoString() string

GoString returns the string representation

func (*DirectoryInUseException) Message added in v1.35.8 

func (s *DirectoryInUseException) Message() string

Message returns the exception's message.

func (*DirectoryInUseException) OrigErr added in v1.35.8 

func (s *DirectoryInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DirectoryInUseException) RequestID added in v1.35.8 

func (s *DirectoryInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DirectoryInUseException) StatusCode added in v1.35.8 

func (s *DirectoryInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DirectoryInUseException) String added in v1.35.8 

func (s DirectoryInUseException) String() string

String returns the string representation

type DirectoryServiceAuthenticationFailedException added in v1.28.0 

type DirectoryServiceAuthenticationFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The directory service doesn't recognize the credentials supplied by WorkMail.

func (*DirectoryServiceAuthenticationFailedException) Code added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) Code() string

Code returns the exception type name.

func (*DirectoryServiceAuthenticationFailedException) Error added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) Error() string

func (DirectoryServiceAuthenticationFailedException) GoString added in v1.28.0 

func (s DirectoryServiceAuthenticationFailedException) GoString() string

GoString returns the string representation

func (*DirectoryServiceAuthenticationFailedException) Message added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) Message() string

Message returns the exception's message.

func (*DirectoryServiceAuthenticationFailedException) OrigErr added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DirectoryServiceAuthenticationFailedException) RequestID added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DirectoryServiceAuthenticationFailedException) StatusCode added in v1.28.0 

func (s *DirectoryServiceAuthenticationFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DirectoryServiceAuthenticationFailedException) String added in v1.28.0 

func (s DirectoryServiceAuthenticationFailedException) String() string

String returns the string representation

type DirectoryUnavailableException added in v1.28.0 

type DirectoryUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The directory is unavailable. It might be located in another Region or deleted.

func (*DirectoryUnavailableException) Code added in v1.28.0 

func (s *DirectoryUnavailableException) Code() string

Code returns the exception type name.

func (*DirectoryUnavailableException) Error added in v1.28.0 

func (s *DirectoryUnavailableException) Error() string

func (DirectoryUnavailableException) GoString added in v1.28.0 

func (s DirectoryUnavailableException) GoString() string

GoString returns the string representation

func (*DirectoryUnavailableException) Message added in v1.28.0 

func (s *DirectoryUnavailableException) Message() string

Message returns the exception's message.

func (*DirectoryUnavailableException) OrigErr added in v1.28.0 

func (s *DirectoryUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DirectoryUnavailableException) RequestID added in v1.28.0 

func (s *DirectoryUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DirectoryUnavailableException) StatusCode added in v1.28.0 

func (s *DirectoryUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DirectoryUnavailableException) String added in v1.28.0 

func (s DirectoryUnavailableException) String() string

String returns the string representation

type DisassociateDelegateFromResourceInput 

type DisassociateDelegateFromResourceInput struct {

	// The identifier for the member (user, group) to be removed from the resource's
	// delegates.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the resource exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier of the resource from which delegates' set members are removed.
	//
	// ResourceId is a required field
	ResourceId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateDelegateFromResourceInput) GoString 

func (s DisassociateDelegateFromResourceInput) GoString() string

GoString returns the string representation

func (*DisassociateDelegateFromResourceInput) SetEntityId 

func (s *DisassociateDelegateFromResourceInput) SetEntityId(v string) *DisassociateDelegateFromResourceInput

SetEntityId sets the EntityId field's value.

func (*DisassociateDelegateFromResourceInput) SetOrganizationId 

func (s *DisassociateDelegateFromResourceInput) SetOrganizationId(v string) *DisassociateDelegateFromResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*DisassociateDelegateFromResourceInput) SetResourceId 

func (s *DisassociateDelegateFromResourceInput) SetResourceId(v string) *DisassociateDelegateFromResourceInput

SetResourceId sets the ResourceId field's value.

func (DisassociateDelegateFromResourceInput) String 

func (s DisassociateDelegateFromResourceInput) String() string

String returns the string representation

func (*DisassociateDelegateFromResourceInput) Validate 

func (s *DisassociateDelegateFromResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateDelegateFromResourceOutput 

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

func (DisassociateDelegateFromResourceOutput) GoString 

func (s DisassociateDelegateFromResourceOutput) GoString() string

GoString returns the string representation

func (DisassociateDelegateFromResourceOutput) String 

func (s DisassociateDelegateFromResourceOutput) String() string

String returns the string representation

type DisassociateMemberFromGroupInput 

type DisassociateMemberFromGroupInput struct {

	// The identifier for the group from which members are removed.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The identifier for the member to be removed to the group.
	//
	// MemberId is a required field
	MemberId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the group exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateMemberFromGroupInput) GoString 

func (s DisassociateMemberFromGroupInput) GoString() string

GoString returns the string representation

func (*DisassociateMemberFromGroupInput) SetGroupId 

func (s *DisassociateMemberFromGroupInput) SetGroupId(v string) *DisassociateMemberFromGroupInput

SetGroupId sets the GroupId field's value.

func (*DisassociateMemberFromGroupInput) SetMemberId 

func (s *DisassociateMemberFromGroupInput) SetMemberId(v string) *DisassociateMemberFromGroupInput

SetMemberId sets the MemberId field's value.

func (*DisassociateMemberFromGroupInput) SetOrganizationId 

func (s *DisassociateMemberFromGroupInput) SetOrganizationId(v string) *DisassociateMemberFromGroupInput

SetOrganizationId sets the OrganizationId field's value.

func (DisassociateMemberFromGroupInput) String 

func (s DisassociateMemberFromGroupInput) String() string

String returns the string representation

func (*DisassociateMemberFromGroupInput) Validate 

func (s *DisassociateMemberFromGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateMemberFromGroupOutput 

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

func (DisassociateMemberFromGroupOutput) GoString 

func (s DisassociateMemberFromGroupOutput) GoString() string

GoString returns the string representation

func (DisassociateMemberFromGroupOutput) String 

func (s DisassociateMemberFromGroupOutput) String() string

String returns the string representation

type Domain added in v1.35.8 

type Domain struct {

	// The fully qualified domain name.
	DomainName *string `min:"3" type:"string"`

	// The hosted zone ID for a domain hosted in Route 53. Required when configuring
	// a domain hosted in Route 53.
	HostedZoneId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The domain to associate with an Amazon WorkMail organization.

When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) in the Amazon WorkMail Administrator Guide.

func (Domain) GoString added in v1.35.8 

func (s Domain) GoString() string

GoString returns the string representation

func (*Domain) SetDomainName added in v1.35.8 

func (s *Domain) SetDomainName(v string) *Domain

SetDomainName sets the DomainName field's value.

func (*Domain) SetHostedZoneId added in v1.35.8 

func (s *Domain) SetHostedZoneId(v string) *Domain

SetHostedZoneId sets the HostedZoneId field's value.

func (Domain) String added in v1.35.8 

func (s Domain) String() string

String returns the string representation

func (*Domain) Validate added in v1.35.8 

func (s *Domain) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EmailAddressInUseException added in v1.28.0 

type EmailAddressInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The email address that you're trying to assign is already created for a different user, group, or resource.

func (*EmailAddressInUseException) Code added in v1.28.0 

func (s *EmailAddressInUseException) Code() string

Code returns the exception type name.

func (*EmailAddressInUseException) Error added in v1.28.0 

func (s *EmailAddressInUseException) Error() string

func (EmailAddressInUseException) GoString added in v1.28.0 

func (s EmailAddressInUseException) GoString() string

GoString returns the string representation

func (*EmailAddressInUseException) Message added in v1.28.0 

func (s *EmailAddressInUseException) Message() string

Message returns the exception's message.

func (*EmailAddressInUseException) OrigErr added in v1.28.0 

func (s *EmailAddressInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EmailAddressInUseException) RequestID added in v1.28.0 

func (s *EmailAddressInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EmailAddressInUseException) StatusCode added in v1.28.0 

func (s *EmailAddressInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EmailAddressInUseException) String added in v1.28.0 

func (s EmailAddressInUseException) String() string

String returns the string representation

type EntityAlreadyRegisteredException added in v1.28.0 

type EntityAlreadyRegisteredException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The user, group, or resource that you're trying to register is already registered.

func (*EntityAlreadyRegisteredException) Code added in v1.28.0 

func (s *EntityAlreadyRegisteredException) Code() string

Code returns the exception type name.

func (*EntityAlreadyRegisteredException) Error added in v1.28.0 

func (s *EntityAlreadyRegisteredException) Error() string

func (EntityAlreadyRegisteredException) GoString added in v1.28.0 

func (s EntityAlreadyRegisteredException) GoString() string

GoString returns the string representation

func (*EntityAlreadyRegisteredException) Message added in v1.28.0 

func (s *EntityAlreadyRegisteredException) Message() string

Message returns the exception's message.

func (*EntityAlreadyRegisteredException) OrigErr added in v1.28.0 

func (s *EntityAlreadyRegisteredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityAlreadyRegisteredException) RequestID added in v1.28.0 

func (s *EntityAlreadyRegisteredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityAlreadyRegisteredException) StatusCode added in v1.28.0 

func (s *EntityAlreadyRegisteredException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityAlreadyRegisteredException) String added in v1.28.0 

func (s EntityAlreadyRegisteredException) String() string

String returns the string representation

type EntityNotFoundException added in v1.28.0 

type EntityNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The identifier supplied for the user, group, or resource does not exist in your organization.

func (*EntityNotFoundException) Code added in v1.28.0 

func (s *EntityNotFoundException) Code() string

Code returns the exception type name.

func (*EntityNotFoundException) Error added in v1.28.0 

func (s *EntityNotFoundException) Error() string

func (EntityNotFoundException) GoString added in v1.28.0 

func (s EntityNotFoundException) GoString() string

GoString returns the string representation

func (*EntityNotFoundException) Message added in v1.28.0 

func (s *EntityNotFoundException) Message() string

Message returns the exception's message.

func (*EntityNotFoundException) OrigErr added in v1.28.0 

func (s *EntityNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityNotFoundException) RequestID added in v1.28.0 

func (s *EntityNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityNotFoundException) StatusCode added in v1.28.0 

func (s *EntityNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityNotFoundException) String added in v1.28.0 

func (s EntityNotFoundException) String() string

String returns the string representation

type EntityStateException added in v1.28.0 

type EntityStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

func (*EntityStateException) Code added in v1.28.0 

func (s *EntityStateException) Code() string

Code returns the exception type name.

func (*EntityStateException) Error added in v1.28.0 

func (s *EntityStateException) Error() string

func (EntityStateException) GoString added in v1.28.0 

func (s EntityStateException) GoString() string

GoString returns the string representation

func (*EntityStateException) Message added in v1.28.0 

func (s *EntityStateException) Message() string

Message returns the exception's message.

func (*EntityStateException) OrigErr added in v1.28.0 

func (s *EntityStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityStateException) RequestID added in v1.28.0 

func (s *EntityStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityStateException) StatusCode added in v1.28.0 

func (s *EntityStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityStateException) String added in v1.28.0 

func (s EntityStateException) String() string

String returns the string representation

type FolderConfiguration added in v1.31.7 

type FolderConfiguration struct {

	// The action to take on the folder contents at the end of the folder configuration
	// period.
	//
	// Action is a required field
	Action *string `type:"string" required:"true" enum:"RetentionAction"`

	// The folder name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"FolderName"`

	// The period of time at which the folder configuration action is applied.
	Period *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The configuration applied to an organization's folders by its retention policy.

func (FolderConfiguration) GoString added in v1.31.7 

func (s FolderConfiguration) GoString() string

GoString returns the string representation

func (*FolderConfiguration) SetAction added in v1.31.7 

func (s *FolderConfiguration) SetAction(v string) *FolderConfiguration

SetAction sets the Action field's value.

func (*FolderConfiguration) SetName added in v1.31.7 

func (s *FolderConfiguration) SetName(v string) *FolderConfiguration

SetName sets the Name field's value.

func (*FolderConfiguration) SetPeriod added in v1.31.7 

func (s *FolderConfiguration) SetPeriod(v int64) *FolderConfiguration

SetPeriod sets the Period field's value.

func (FolderConfiguration) String added in v1.31.7 

func (s FolderConfiguration) String() string

String returns the string representation

func (*FolderConfiguration) Validate added in v1.31.7 

func (s *FolderConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccessControlEffectInput added in v1.29.1 

type GetAccessControlEffectInput struct {

	// The access protocol action. Valid values include ActiveSync, AutoDiscover,
	// EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
	//
	// Action is a required field
	Action *string `min:"1" type:"string" required:"true"`

	// The IPv4 address.
	//
	// IpAddress is a required field
	IpAddress *string `min:"1" type:"string" required:"true"`

	// The identifier for the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccessControlEffectInput) GoString added in v1.29.1 

func (s GetAccessControlEffectInput) GoString() string

GoString returns the string representation

func (*GetAccessControlEffectInput) SetAction added in v1.29.1 

func (s *GetAccessControlEffectInput) SetAction(v string) *GetAccessControlEffectInput

SetAction sets the Action field's value.

func (*GetAccessControlEffectInput) SetIpAddress added in v1.29.1 

func (s *GetAccessControlEffectInput) SetIpAddress(v string) *GetAccessControlEffectInput

SetIpAddress sets the IpAddress field's value.

func (*GetAccessControlEffectInput) SetOrganizationId added in v1.29.1 

func (s *GetAccessControlEffectInput) SetOrganizationId(v string) *GetAccessControlEffectInput

SetOrganizationId sets the OrganizationId field's value.

func (*GetAccessControlEffectInput) SetUserId added in v1.29.1 

func (s *GetAccessControlEffectInput) SetUserId(v string) *GetAccessControlEffectInput

SetUserId sets the UserId field's value.

func (GetAccessControlEffectInput) String added in v1.29.1 

func (s GetAccessControlEffectInput) String() string

String returns the string representation

func (*GetAccessControlEffectInput) Validate added in v1.29.1 

func (s *GetAccessControlEffectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccessControlEffectOutput added in v1.29.1 

type GetAccessControlEffectOutput struct {

	// The rule effect.
	Effect *string `type:"string" enum:"AccessControlRuleEffect"`

	// The rules that match the given parameters, resulting in an effect.
	MatchedRules []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetAccessControlEffectOutput) GoString added in v1.29.1 

func (s GetAccessControlEffectOutput) GoString() string

GoString returns the string representation

func (*GetAccessControlEffectOutput) SetEffect added in v1.29.1 

func (s *GetAccessControlEffectOutput) SetEffect(v string) *GetAccessControlEffectOutput

SetEffect sets the Effect field's value.

func (*GetAccessControlEffectOutput) SetMatchedRules added in v1.29.1 

func (s *GetAccessControlEffectOutput) SetMatchedRules(v []*string) *GetAccessControlEffectOutput

SetMatchedRules sets the MatchedRules field's value.

func (GetAccessControlEffectOutput) String added in v1.29.1 

func (s GetAccessControlEffectOutput) String() string

String returns the string representation

type GetDefaultRetentionPolicyInput added in v1.31.7 

type GetDefaultRetentionPolicyInput struct {

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDefaultRetentionPolicyInput) GoString added in v1.31.7 

func (s GetDefaultRetentionPolicyInput) GoString() string

GoString returns the string representation

func (*GetDefaultRetentionPolicyInput) SetOrganizationId added in v1.31.7 

func (s *GetDefaultRetentionPolicyInput) SetOrganizationId(v string) *GetDefaultRetentionPolicyInput

SetOrganizationId sets the OrganizationId field's value.

func (GetDefaultRetentionPolicyInput) String added in v1.31.7 

func (s GetDefaultRetentionPolicyInput) String() string

String returns the string representation

func (*GetDefaultRetentionPolicyInput) Validate added in v1.31.7 

func (s *GetDefaultRetentionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDefaultRetentionPolicyOutput added in v1.31.7 

type GetDefaultRetentionPolicyOutput struct {

	// The retention policy description.
	Description *string `type:"string"`

	// The retention policy folder configurations.
	FolderConfigurations []*FolderConfiguration `type:"list"`

	// The retention policy ID.
	Id *string `min:"1" type:"string"`

	// The retention policy name.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDefaultRetentionPolicyOutput) GoString added in v1.31.7 

func (s GetDefaultRetentionPolicyOutput) GoString() string

GoString returns the string representation

func (*GetDefaultRetentionPolicyOutput) SetDescription added in v1.31.7 

func (s *GetDefaultRetentionPolicyOutput) SetDescription(v string) *GetDefaultRetentionPolicyOutput

SetDescription sets the Description field's value.

func (*GetDefaultRetentionPolicyOutput) SetFolderConfigurations added in v1.31.7 

func (s *GetDefaultRetentionPolicyOutput) SetFolderConfigurations(v []*FolderConfiguration) *GetDefaultRetentionPolicyOutput

SetFolderConfigurations sets the FolderConfigurations field's value.

func (*GetDefaultRetentionPolicyOutput) SetId added in v1.31.7 

func (s *GetDefaultRetentionPolicyOutput) SetId(v string) *GetDefaultRetentionPolicyOutput

SetId sets the Id field's value.

func (*GetDefaultRetentionPolicyOutput) SetName added in v1.31.7 

func (s *GetDefaultRetentionPolicyOutput) SetName(v string) *GetDefaultRetentionPolicyOutput

SetName sets the Name field's value.

func (GetDefaultRetentionPolicyOutput) String added in v1.31.7 

func (s GetDefaultRetentionPolicyOutput) String() string

String returns the string representation

type GetMailboxDetailsInput added in v1.19.24 

type GetMailboxDetailsInput struct {

	// The identifier for the organization that contains the user whose mailbox
	// details are being requested.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier for the user whose mailbox details are being requested.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMailboxDetailsInput) GoString added in v1.19.24 

func (s GetMailboxDetailsInput) GoString() string

GoString returns the string representation

func (*GetMailboxDetailsInput) SetOrganizationId added in v1.19.24 

func (s *GetMailboxDetailsInput) SetOrganizationId(v string) *GetMailboxDetailsInput

SetOrganizationId sets the OrganizationId field's value.

func (*GetMailboxDetailsInput) SetUserId added in v1.19.24 

func (s *GetMailboxDetailsInput) SetUserId(v string) *GetMailboxDetailsInput

SetUserId sets the UserId field's value.

func (GetMailboxDetailsInput) String added in v1.19.24 

func (s GetMailboxDetailsInput) String() string

String returns the string representation

func (*GetMailboxDetailsInput) Validate added in v1.19.24 

func (s *GetMailboxDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMailboxDetailsOutput added in v1.19.24 

type GetMailboxDetailsOutput struct {

	// The maximum allowed mailbox size, in MB, for the specified user.
	MailboxQuota *int64 `min:"1" type:"integer"`

	// The current mailbox size, in MB, for the specified user.
	MailboxSize *float64 `type:"double"`
	// contains filtered or unexported fields
}

func (GetMailboxDetailsOutput) GoString added in v1.19.24 

func (s GetMailboxDetailsOutput) GoString() string

GoString returns the string representation

func (*GetMailboxDetailsOutput) SetMailboxQuota added in v1.19.24 

func (s *GetMailboxDetailsOutput) SetMailboxQuota(v int64) *GetMailboxDetailsOutput

SetMailboxQuota sets the MailboxQuota field's value.

func (*GetMailboxDetailsOutput) SetMailboxSize added in v1.19.24 

func (s *GetMailboxDetailsOutput) SetMailboxSize(v float64) *GetMailboxDetailsOutput

SetMailboxSize sets the MailboxSize field's value.

func (GetMailboxDetailsOutput) String added in v1.19.24 

func (s GetMailboxDetailsOutput) String() string

String returns the string representation

type GetMobileDeviceAccessEffectInput added in v1.38.10 

type GetMobileDeviceAccessEffectInput struct {

	// Device model the simulated user will report.
	DeviceModel *string `min:"1" type:"string"`

	// Device operating system the simulated user will report.
	DeviceOperatingSystem *string `min:"1" type:"string"`

	// Device type the simulated user will report.
	DeviceType *string `min:"1" type:"string"`

	// Device user agent the simulated user will report.
	DeviceUserAgent *string `min:"1" type:"string"`

	// The Amazon WorkMail organization to simulate the access effect for.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMobileDeviceAccessEffectInput) GoString added in v1.38.10 

func (s GetMobileDeviceAccessEffectInput) GoString() string

GoString returns the string representation

func (*GetMobileDeviceAccessEffectInput) SetDeviceModel added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) SetDeviceModel(v string) *GetMobileDeviceAccessEffectInput

SetDeviceModel sets the DeviceModel field's value.

func (*GetMobileDeviceAccessEffectInput) SetDeviceOperatingSystem added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) SetDeviceOperatingSystem(v string) *GetMobileDeviceAccessEffectInput

SetDeviceOperatingSystem sets the DeviceOperatingSystem field's value.

func (*GetMobileDeviceAccessEffectInput) SetDeviceType added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) SetDeviceType(v string) *GetMobileDeviceAccessEffectInput

SetDeviceType sets the DeviceType field's value.

func (*GetMobileDeviceAccessEffectInput) SetDeviceUserAgent added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) SetDeviceUserAgent(v string) *GetMobileDeviceAccessEffectInput

SetDeviceUserAgent sets the DeviceUserAgent field's value.

func (*GetMobileDeviceAccessEffectInput) SetOrganizationId added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) SetOrganizationId(v string) *GetMobileDeviceAccessEffectInput

SetOrganizationId sets the OrganizationId field's value.

func (GetMobileDeviceAccessEffectInput) String added in v1.38.10 

func (s GetMobileDeviceAccessEffectInput) String() string

String returns the string representation

func (*GetMobileDeviceAccessEffectInput) Validate added in v1.38.10 

func (s *GetMobileDeviceAccessEffectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMobileDeviceAccessEffectOutput added in v1.38.10 

type GetMobileDeviceAccessEffectOutput struct {

	// The effect of the simulated access, ALLOW or DENY, after evaluating mobile
	// device access rules in the Amazon WorkMail organization for the simulated
	// user parameters.
	Effect *string `type:"string" enum:"MobileDeviceAccessRuleEffect"`

	// A list of the rules which matched the simulated user input and produced the
	// effect.
	MatchedRules []*MobileDeviceAccessMatchedRule `type:"list"`
	// contains filtered or unexported fields
}

func (GetMobileDeviceAccessEffectOutput) GoString added in v1.38.10 

func (s GetMobileDeviceAccessEffectOutput) GoString() string

GoString returns the string representation

func (*GetMobileDeviceAccessEffectOutput) SetEffect added in v1.38.10 

func (s *GetMobileDeviceAccessEffectOutput) SetEffect(v string) *GetMobileDeviceAccessEffectOutput

SetEffect sets the Effect field's value.

func (*GetMobileDeviceAccessEffectOutput) SetMatchedRules added in v1.38.10 

func (s *GetMobileDeviceAccessEffectOutput) SetMatchedRules(v []*MobileDeviceAccessMatchedRule) *GetMobileDeviceAccessEffectOutput

SetMatchedRules sets the MatchedRules field's value.

func (GetMobileDeviceAccessEffectOutput) String added in v1.38.10 

func (s GetMobileDeviceAccessEffectOutput) String() string

String returns the string representation

type Group 

type Group struct {

	// The date indicating when the group was disabled from Amazon WorkMail use.
	DisabledDate *time.Time `type:"timestamp"`

	// The email of the group.
	Email *string `min:"1" type:"string"`

	// The date indicating when the group was enabled for Amazon WorkMail use.
	EnabledDate *time.Time `type:"timestamp"`

	// The identifier of the group.
	Id *string `min:"12" type:"string"`

	// The name of the group.
	Name *string `min:"1" type:"string"`

	// The state of the group, which can be ENABLED, DISABLED, or DELETED.
	State *string `type:"string" enum:"EntityState"`
	// contains filtered or unexported fields
}

The representation of an Amazon WorkMail group.

func (Group) GoString 

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetDisabledDate 

func (s *Group) SetDisabledDate(v time.Time) *Group

SetDisabledDate sets the DisabledDate field's value.

func (*Group) SetEmail 

func (s *Group) SetEmail(v string) *Group

SetEmail sets the Email field's value.

func (*Group) SetEnabledDate 

func (s *Group) SetEnabledDate(v time.Time) *Group

SetEnabledDate sets the EnabledDate field's value.

func (*Group) SetId 

func (s *Group) SetId(v string) *Group

SetId sets the Id field's value.

func (*Group) SetName 

func (s *Group) SetName(v string) *Group

SetName sets the Name field's value.

func (*Group) SetState 

func (s *Group) SetState(v string) *Group

SetState sets the State field's value.

func (Group) String 

func (s Group) String() string

String returns the string representation

type InvalidConfigurationException added in v1.28.0 

type InvalidConfigurationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

func (*InvalidConfigurationException) Code added in v1.28.0 

func (s *InvalidConfigurationException) Code() string

Code returns the exception type name.

func (*InvalidConfigurationException) Error added in v1.28.0 

func (s *InvalidConfigurationException) Error() string

func (InvalidConfigurationException) GoString added in v1.28.0 

func (s InvalidConfigurationException) GoString() string

GoString returns the string representation

func (*InvalidConfigurationException) Message added in v1.28.0 

func (s *InvalidConfigurationException) Message() string

Message returns the exception's message.

func (*InvalidConfigurationException) OrigErr added in v1.28.0 

func (s *InvalidConfigurationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidConfigurationException) RequestID added in v1.28.0 

func (s *InvalidConfigurationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidConfigurationException) StatusCode added in v1.28.0 

func (s *InvalidConfigurationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidConfigurationException) String added in v1.28.0 

func (s InvalidConfigurationException) String() string

String returns the string representation

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

One or more of the input parameters don't match the service's restrictions.

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation

type InvalidPasswordException added in v1.28.0 

type InvalidPasswordException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

func (*InvalidPasswordException) Code added in v1.28.0 

func (s *InvalidPasswordException) Code() string

Code returns the exception type name.

func (*InvalidPasswordException) Error added in v1.28.0 

func (s *InvalidPasswordException) Error() string

func (InvalidPasswordException) GoString added in v1.28.0 

func (s InvalidPasswordException) GoString() string

GoString returns the string representation

func (*InvalidPasswordException) Message added in v1.28.0 

func (s *InvalidPasswordException) Message() string

Message returns the exception's message.

func (*InvalidPasswordException) OrigErr added in v1.28.0 

func (s *InvalidPasswordException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPasswordException) RequestID added in v1.28.0 

func (s *InvalidPasswordException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPasswordException) StatusCode added in v1.28.0 

func (s *InvalidPasswordException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPasswordException) String added in v1.28.0 

func (s InvalidPasswordException) String() string

String returns the string representation

type LimitExceededException added in v1.28.10 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request exceeds the limit of the resource.

func (*LimitExceededException) Code added in v1.28.10 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.10 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.10 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.10 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.10 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.10 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.10 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.10 

func (s LimitExceededException) String() string

String returns the string representation

type ListAccessControlRulesInput added in v1.29.1 

type ListAccessControlRulesInput struct {

	// The identifier for the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAccessControlRulesInput) GoString added in v1.29.1 

func (s ListAccessControlRulesInput) GoString() string

GoString returns the string representation

func (*ListAccessControlRulesInput) SetOrganizationId added in v1.29.1 

func (s *ListAccessControlRulesInput) SetOrganizationId(v string) *ListAccessControlRulesInput

SetOrganizationId sets the OrganizationId field's value.

func (ListAccessControlRulesInput) String added in v1.29.1 

func (s ListAccessControlRulesInput) String() string

String returns the string representation

func (*ListAccessControlRulesInput) Validate added in v1.29.1 

func (s *ListAccessControlRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessControlRulesOutput added in v1.29.1 

type ListAccessControlRulesOutput struct {

	// The access control rules.
	Rules []*AccessControlRule `type:"list"`
	// contains filtered or unexported fields
}

func (ListAccessControlRulesOutput) GoString added in v1.29.1 

func (s ListAccessControlRulesOutput) GoString() string

GoString returns the string representation

func (*ListAccessControlRulesOutput) SetRules added in v1.29.1 

func (s *ListAccessControlRulesOutput) SetRules(v []*AccessControlRule) *ListAccessControlRulesOutput

SetRules sets the Rules field's value.

func (ListAccessControlRulesOutput) String added in v1.29.1 

func (s ListAccessControlRulesOutput) String() string

String returns the string representation

type ListAliasesInput 

type ListAliasesInput struct {

	// The identifier for the entity for which to list the aliases.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization under which the entity exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAliasesInput) GoString 

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (*ListAliasesInput) SetEntityId 

func (s *ListAliasesInput) SetEntityId(v string) *ListAliasesInput

SetEntityId sets the EntityId field's value.

func (*ListAliasesInput) SetMaxResults 

func (s *ListAliasesInput) SetMaxResults(v int64) *ListAliasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAliasesInput) SetNextToken 

func (s *ListAliasesInput) SetNextToken(v string) *ListAliasesInput

SetNextToken sets the NextToken field's value.

func (*ListAliasesInput) SetOrganizationId 

func (s *ListAliasesInput) SetOrganizationId(v string) *ListAliasesInput

SetOrganizationId sets the OrganizationId field's value.

func (ListAliasesInput) String 

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate 

func (s *ListAliasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAliasesOutput 

type ListAliasesOutput struct {

	// The entity's paginated aliases.
	Aliases []*string `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAliasesOutput) GoString 

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (*ListAliasesOutput) SetAliases 

func (s *ListAliasesOutput) SetAliases(v []*string) *ListAliasesOutput

SetAliases sets the Aliases field's value.

func (*ListAliasesOutput) SetNextToken 

func (s *ListAliasesOutput) SetNextToken(v string) *ListAliasesOutput

SetNextToken sets the NextToken field's value.

func (ListAliasesOutput) String 

func (s ListAliasesOutput) String() string

String returns the string representation

type ListGroupMembersInput 

type ListGroupMembersInput struct {

	// The identifier for the group to which the members (users or groups) are associated.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization under which the group exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListGroupMembersInput) GoString 

func (s ListGroupMembersInput) GoString() string

GoString returns the string representation

func (*ListGroupMembersInput) SetGroupId 

func (s *ListGroupMembersInput) SetGroupId(v string) *ListGroupMembersInput

SetGroupId sets the GroupId field's value.

func (*ListGroupMembersInput) SetMaxResults 

func (s *ListGroupMembersInput) SetMaxResults(v int64) *ListGroupMembersInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupMembersInput) SetNextToken 

func (s *ListGroupMembersInput) SetNextToken(v string) *ListGroupMembersInput

SetNextToken sets the NextToken field's value.

func (*ListGroupMembersInput) SetOrganizationId 

func (s *ListGroupMembersInput) SetOrganizationId(v string) *ListGroupMembersInput

SetOrganizationId sets the OrganizationId field's value.

func (ListGroupMembersInput) String 

func (s ListGroupMembersInput) String() string

String returns the string representation

func (*ListGroupMembersInput) Validate 

func (s *ListGroupMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupMembersOutput 

type ListGroupMembersOutput struct {

	// The members associated to the group.
	Members []*Member `type:"list"`

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

func (ListGroupMembersOutput) GoString 

func (s ListGroupMembersOutput) GoString() string

GoString returns the string representation

func (*ListGroupMembersOutput) SetMembers 

func (s *ListGroupMembersOutput) SetMembers(v []*Member) *ListGroupMembersOutput

SetMembers sets the Members field's value.

func (*ListGroupMembersOutput) SetNextToken 

func (s *ListGroupMembersOutput) SetNextToken(v string) *ListGroupMembersOutput

SetNextToken sets the NextToken field's value.

func (ListGroupMembersOutput) String 

func (s ListGroupMembersOutput) String() string

String returns the string representation

type ListGroupsInput 

type ListGroupsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization under which the groups exist.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListGroupsInput) GoString 

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (*ListGroupsInput) SetMaxResults 

func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken 

func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput

SetNextToken sets the NextToken field's value.

func (*ListGroupsInput) SetOrganizationId 

func (s *ListGroupsInput) SetOrganizationId(v string) *ListGroupsInput

SetOrganizationId sets the OrganizationId field's value.

func (ListGroupsInput) String 

func (s ListGroupsInput) String() string

String returns the string representation

func (*ListGroupsInput) Validate 

func (s *ListGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupsOutput 

type ListGroupsOutput struct {

	// The overview of groups for an organization.
	Groups []*Group `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsOutput) GoString 

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (*ListGroupsOutput) SetGroups 

func (s *ListGroupsOutput) SetGroups(v []*Group) *ListGroupsOutput

SetGroups sets the Groups field's value.

func (*ListGroupsOutput) SetNextToken 

func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String 

func (s ListGroupsOutput) String() string

String returns the string representation

type ListMailboxExportJobsInput added in v1.34.29 

type ListMailboxExportJobsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results.
	NextToken *string `min:"1" type:"string"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListMailboxExportJobsInput) GoString added in v1.34.29 

func (s ListMailboxExportJobsInput) GoString() string

GoString returns the string representation

func (*ListMailboxExportJobsInput) SetMaxResults added in v1.34.29 

func (s *ListMailboxExportJobsInput) SetMaxResults(v int64) *ListMailboxExportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMailboxExportJobsInput) SetNextToken added in v1.34.29 

func (s *ListMailboxExportJobsInput) SetNextToken(v string) *ListMailboxExportJobsInput

SetNextToken sets the NextToken field's value.

func (*ListMailboxExportJobsInput) SetOrganizationId added in v1.34.29 

func (s *ListMailboxExportJobsInput) SetOrganizationId(v string) *ListMailboxExportJobsInput

SetOrganizationId sets the OrganizationId field's value.

func (ListMailboxExportJobsInput) String added in v1.34.29 

func (s ListMailboxExportJobsInput) String() string

String returns the string representation

func (*ListMailboxExportJobsInput) Validate added in v1.34.29 

func (s *ListMailboxExportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMailboxExportJobsOutput added in v1.34.29 

type ListMailboxExportJobsOutput struct {

	// The mailbox export job details.
	Jobs []*MailboxExportJob `type:"list"`

	// The token to use to retrieve the next page of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMailboxExportJobsOutput) GoString added in v1.34.29 

func (s ListMailboxExportJobsOutput) GoString() string

GoString returns the string representation

func (*ListMailboxExportJobsOutput) SetJobs added in v1.34.29 

func (s *ListMailboxExportJobsOutput) SetJobs(v []*MailboxExportJob) *ListMailboxExportJobsOutput

SetJobs sets the Jobs field's value.

func (*ListMailboxExportJobsOutput) SetNextToken added in v1.34.29 

func (s *ListMailboxExportJobsOutput) SetNextToken(v string) *ListMailboxExportJobsOutput

SetNextToken sets the NextToken field's value.

func (ListMailboxExportJobsOutput) String added in v1.34.29 

func (s ListMailboxExportJobsOutput) String() string

String returns the string representation

type ListMailboxPermissionsInput added in v1.13.32 

type ListMailboxPermissionsInput struct {

	// The identifier of the user, group, or resource for which to list mailbox
	// permissions.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListMailboxPermissionsInput) GoString added in v1.13.32 

func (s ListMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*ListMailboxPermissionsInput) SetEntityId added in v1.13.32 

func (s *ListMailboxPermissionsInput) SetEntityId(v string) *ListMailboxPermissionsInput

SetEntityId sets the EntityId field's value.

func (*ListMailboxPermissionsInput) SetMaxResults added in v1.13.32 

func (s *ListMailboxPermissionsInput) SetMaxResults(v int64) *ListMailboxPermissionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMailboxPermissionsInput) SetNextToken added in v1.13.32 

func (s *ListMailboxPermissionsInput) SetNextToken(v string) *ListMailboxPermissionsInput

SetNextToken sets the NextToken field's value.

func (*ListMailboxPermissionsInput) SetOrganizationId added in v1.13.32 

func (s *ListMailboxPermissionsInput) SetOrganizationId(v string) *ListMailboxPermissionsInput

SetOrganizationId sets the OrganizationId field's value.

func (ListMailboxPermissionsInput) String added in v1.13.32 

func (s ListMailboxPermissionsInput) String() string

String returns the string representation

func (*ListMailboxPermissionsInput) Validate added in v1.13.32 

func (s *ListMailboxPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMailboxPermissionsOutput added in v1.13.32 

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 `min:"1" type:"string"`

	// One page of the user, group, or resource mailbox permissions.
	Permissions []*Permission `type:"list"`
	// contains filtered or unexported fields
}

func (ListMailboxPermissionsOutput) GoString added in v1.13.32 

func (s ListMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (*ListMailboxPermissionsOutput) SetNextToken added in v1.13.32 

func (s *ListMailboxPermissionsOutput) SetNextToken(v string) *ListMailboxPermissionsOutput

SetNextToken sets the NextToken field's value.

func (*ListMailboxPermissionsOutput) SetPermissions added in v1.13.32 

func (s *ListMailboxPermissionsOutput) SetPermissions(v []*Permission) *ListMailboxPermissionsOutput

SetPermissions sets the Permissions field's value.

func (ListMailboxPermissionsOutput) String added in v1.13.32 

func (s ListMailboxPermissionsOutput) String() string

String returns the string representation

type ListMobileDeviceAccessRulesInput added in v1.38.10 

type ListMobileDeviceAccessRulesInput struct {

	// The Amazon WorkMail organization for which to list the rules.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListMobileDeviceAccessRulesInput) GoString added in v1.38.10 

func (s ListMobileDeviceAccessRulesInput) GoString() string

GoString returns the string representation

func (*ListMobileDeviceAccessRulesInput) SetOrganizationId added in v1.38.10 

func (s *ListMobileDeviceAccessRulesInput) SetOrganizationId(v string) *ListMobileDeviceAccessRulesInput

SetOrganizationId sets the OrganizationId field's value.

func (ListMobileDeviceAccessRulesInput) String added in v1.38.10 

func (s ListMobileDeviceAccessRulesInput) String() string

String returns the string representation

func (*ListMobileDeviceAccessRulesInput) Validate added in v1.38.10 

func (s *ListMobileDeviceAccessRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMobileDeviceAccessRulesOutput added in v1.38.10 

type ListMobileDeviceAccessRulesOutput struct {

	// The list of mobile device access rules that exist under the specified Amazon
	// WorkMail organization.
	Rules []*MobileDeviceAccessRule `type:"list"`
	// contains filtered or unexported fields
}

func (ListMobileDeviceAccessRulesOutput) GoString added in v1.38.10 

func (s ListMobileDeviceAccessRulesOutput) GoString() string

GoString returns the string representation

func (*ListMobileDeviceAccessRulesOutput) SetRules added in v1.38.10 

func (s *ListMobileDeviceAccessRulesOutput) SetRules(v []*MobileDeviceAccessRule) *ListMobileDeviceAccessRulesOutput

SetRules sets the Rules field's value.

func (ListMobileDeviceAccessRulesOutput) String added in v1.38.10 

func (s ListMobileDeviceAccessRulesOutput) String() string

String returns the string representation

type ListOrganizationsInput 

type ListOrganizationsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListOrganizationsInput) GoString 

func (s ListOrganizationsInput) GoString() string

GoString returns the string representation

func (*ListOrganizationsInput) SetMaxResults 

func (s *ListOrganizationsInput) SetMaxResults(v int64) *ListOrganizationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListOrganizationsInput) SetNextToken 

func (s *ListOrganizationsInput) SetNextToken(v string) *ListOrganizationsInput

SetNextToken sets the NextToken field's value.

func (ListOrganizationsInput) String 

func (s ListOrganizationsInput) String() string

String returns the string representation

func (*ListOrganizationsInput) Validate 

func (s *ListOrganizationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// The overview of owned organizations presented as a list of organization summaries.
	OrganizationSummaries []*OrganizationSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListOrganizationsOutput) GoString 

func (s ListOrganizationsOutput) GoString() string

GoString returns the string representation

func (*ListOrganizationsOutput) SetNextToken 

func (s *ListOrganizationsOutput) SetNextToken(v string) *ListOrganizationsOutput

SetNextToken sets the NextToken field's value.

func (*ListOrganizationsOutput) SetOrganizationSummaries 

func (s *ListOrganizationsOutput) SetOrganizationSummaries(v []*OrganizationSummary) *ListOrganizationsOutput

SetOrganizationSummaries sets the OrganizationSummaries field's value.

func (ListOrganizationsOutput) String 

func (s ListOrganizationsOutput) String() string

String returns the string representation

type ListResourceDelegatesInput 

type ListResourceDelegatesInput struct {

	// The number of maximum results in a page.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token used to paginate through the delegates associated with a resource.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization that contains the resource for which
	// delegates are listed.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier for the resource whose delegates are listed.
	//
	// ResourceId is a required field
	ResourceId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourceDelegatesInput) GoString 

func (s ListResourceDelegatesInput) GoString() string

GoString returns the string representation

func (*ListResourceDelegatesInput) SetMaxResults 

func (s *ListResourceDelegatesInput) SetMaxResults(v int64) *ListResourceDelegatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListResourceDelegatesInput) SetNextToken 

func (s *ListResourceDelegatesInput) SetNextToken(v string) *ListResourceDelegatesInput

SetNextToken sets the NextToken field's value.

func (*ListResourceDelegatesInput) SetOrganizationId 

func (s *ListResourceDelegatesInput) SetOrganizationId(v string) *ListResourceDelegatesInput

SetOrganizationId sets the OrganizationId field's value.

func (*ListResourceDelegatesInput) SetResourceId 

func (s *ListResourceDelegatesInput) SetResourceId(v string) *ListResourceDelegatesInput

SetResourceId sets the ResourceId field's value.

func (ListResourceDelegatesInput) String 

func (s ListResourceDelegatesInput) String() string

String returns the string representation

func (*ListResourceDelegatesInput) Validate 

func (s *ListResourceDelegatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourceDelegatesOutput 

type ListResourceDelegatesOutput struct {

	// One page of the resource's delegates.
	Delegates []*Delegate `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListResourceDelegatesOutput) GoString 

func (s ListResourceDelegatesOutput) GoString() string

GoString returns the string representation

func (*ListResourceDelegatesOutput) SetDelegates 

func (s *ListResourceDelegatesOutput) SetDelegates(v []*Delegate) *ListResourceDelegatesOutput

SetDelegates sets the Delegates field's value.

func (*ListResourceDelegatesOutput) SetNextToken 

func (s *ListResourceDelegatesOutput) SetNextToken(v string) *ListResourceDelegatesOutput

SetNextToken sets the NextToken field's value.

func (ListResourceDelegatesOutput) String 

func (s ListResourceDelegatesOutput) String() string

String returns the string representation

type ListResourcesInput 

type ListResourcesInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization under which the resources exist.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourcesInput) GoString 

func (s ListResourcesInput) GoString() string

GoString returns the string representation

func (*ListResourcesInput) SetMaxResults 

func (s *ListResourcesInput) SetMaxResults(v int64) *ListResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInput) SetNextToken 

func (s *ListResourcesInput) SetNextToken(v string) *ListResourcesInput

SetNextToken sets the NextToken field's value.

func (*ListResourcesInput) SetOrganizationId 

func (s *ListResourcesInput) SetOrganizationId(v string) *ListResourcesInput

SetOrganizationId sets the OrganizationId field's value.

func (ListResourcesInput) String 

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate 

func (s *ListResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// One page of the organization's resource representation.
	Resources []*Resource `type:"list"`
	// contains filtered or unexported fields
}

func (ListResourcesOutput) GoString 

func (s ListResourcesOutput) GoString() string

GoString returns the string representation

func (*ListResourcesOutput) SetNextToken 

func (s *ListResourcesOutput) SetNextToken(v string) *ListResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListResourcesOutput) SetResources 

func (s *ListResourcesOutput) SetResources(v []*Resource) *ListResourcesOutput

SetResources sets the Resources field's value.

func (ListResourcesOutput) String 

func (s ListResourcesOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.28.10 

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.28.10 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceARN added in v1.28.10 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.28.10 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.28.10 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.28.10 

type ListTagsForResourceOutput struct {

	// A list of tag key-value pairs.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.28.10 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.28.10 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.28.10 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListUsersInput 

type ListUsersInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next page of results. The first call does
	// not contain any tokens.
	NextToken *string `min:"1" type:"string"`

	// The identifier for the organization under which the users exist.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetMaxResults 

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken 

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (*ListUsersInput) SetOrganizationId 

func (s *ListUsersInput) SetOrganizationId(v string) *ListUsersInput

SetOrganizationId sets the OrganizationId field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// The overview of users for an organization.
	Users []*User `type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersOutput) GoString 

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken 

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUsers 

func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput

SetUsers sets the Users field's value.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation

type MailDomainNotFoundException added in v1.28.0 

type MailDomainNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

func (*MailDomainNotFoundException) Code added in v1.28.0 

func (s *MailDomainNotFoundException) Code() string

Code returns the exception type name.

func (*MailDomainNotFoundException) Error added in v1.28.0 

func (s *MailDomainNotFoundException) Error() string

func (MailDomainNotFoundException) GoString added in v1.28.0 

func (s MailDomainNotFoundException) GoString() string

GoString returns the string representation

func (*MailDomainNotFoundException) Message added in v1.28.0 

func (s *MailDomainNotFoundException) Message() string

Message returns the exception's message.

func (*MailDomainNotFoundException) OrigErr added in v1.28.0 

func (s *MailDomainNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MailDomainNotFoundException) RequestID added in v1.28.0 

func (s *MailDomainNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MailDomainNotFoundException) StatusCode added in v1.28.0 

func (s *MailDomainNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MailDomainNotFoundException) String added in v1.28.0 

func (s MailDomainNotFoundException) String() string

String returns the string representation

type MailDomainStateException added in v1.28.0 

type MailDomainStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

func (*MailDomainStateException) Code added in v1.28.0 

func (s *MailDomainStateException) Code() string

Code returns the exception type name.

func (*MailDomainStateException) Error added in v1.28.0 

func (s *MailDomainStateException) Error() string

func (MailDomainStateException) GoString added in v1.28.0 

func (s MailDomainStateException) GoString() string

GoString returns the string representation

func (*MailDomainStateException) Message added in v1.28.0 

func (s *MailDomainStateException) Message() string

Message returns the exception's message.

func (*MailDomainStateException) OrigErr added in v1.28.0 

func (s *MailDomainStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MailDomainStateException) RequestID added in v1.28.0 

func (s *MailDomainStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MailDomainStateException) StatusCode added in v1.28.0 

func (s *MailDomainStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MailDomainStateException) String added in v1.28.0 

func (s MailDomainStateException) String() string

String returns the string representation

type MailboxExportJob added in v1.34.29 

type MailboxExportJob struct {

	// The mailbox export job description.
	Description *string `type:"string"`

	// The mailbox export job end timestamp.
	EndTime *time.Time `type:"timestamp"`

	// The identifier of the user or resource associated with the mailbox.
	EntityId *string `min:"12" type:"string"`

	// The estimated progress of the mailbox export job, in percentage points.
	EstimatedProgress *int64 `type:"integer"`

	// The identifier of the mailbox export job.
	JobId *string `min:"1" type:"string"`

	// The name of the S3 bucket.
	S3BucketName *string `min:"1" type:"string"`

	// The path to the S3 bucket and file that the mailbox export job exports to.
	S3Path *string `min:"1" type:"string"`

	// The mailbox export job start timestamp.
	StartTime *time.Time `type:"timestamp"`

	// The state of the mailbox export job.
	State *string `type:"string" enum:"MailboxExportJobState"`
	// contains filtered or unexported fields
}

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

func (MailboxExportJob) GoString added in v1.34.29 

func (s MailboxExportJob) GoString() string

GoString returns the string representation

func (*MailboxExportJob) SetDescription added in v1.34.29 

func (s *MailboxExportJob) SetDescription(v string) *MailboxExportJob

SetDescription sets the Description field's value.

func (*MailboxExportJob) SetEndTime added in v1.34.29 

func (s *MailboxExportJob) SetEndTime(v time.Time) *MailboxExportJob

SetEndTime sets the EndTime field's value.

func (*MailboxExportJob) SetEntityId added in v1.34.29 

func (s *MailboxExportJob) SetEntityId(v string) *MailboxExportJob

SetEntityId sets the EntityId field's value.

func (*MailboxExportJob) SetEstimatedProgress added in v1.34.29 

func (s *MailboxExportJob) SetEstimatedProgress(v int64) *MailboxExportJob

SetEstimatedProgress sets the EstimatedProgress field's value.

func (*MailboxExportJob) SetJobId added in v1.34.29 

func (s *MailboxExportJob) SetJobId(v string) *MailboxExportJob

SetJobId sets the JobId field's value.

func (*MailboxExportJob) SetS3BucketName added in v1.34.29 

func (s *MailboxExportJob) SetS3BucketName(v string) *MailboxExportJob

SetS3BucketName sets the S3BucketName field's value.

func (*MailboxExportJob) SetS3Path added in v1.34.29 

func (s *MailboxExportJob) SetS3Path(v string) *MailboxExportJob

SetS3Path sets the S3Path field's value.

func (*MailboxExportJob) SetStartTime added in v1.34.29 

func (s *MailboxExportJob) SetStartTime(v time.Time) *MailboxExportJob

SetStartTime sets the StartTime field's value.

func (*MailboxExportJob) SetState added in v1.34.29 

func (s *MailboxExportJob) SetState(v string) *MailboxExportJob

SetState sets the State field's value.

func (MailboxExportJob) String added in v1.34.29 

func (s MailboxExportJob) String() string

String returns the string representation

type Member 

type Member struct {

	// The date indicating when the member was disabled from Amazon WorkMail use.
	DisabledDate *time.Time `type:"timestamp"`

	// The date indicating when the member was enabled for Amazon WorkMail use.
	EnabledDate *time.Time `type:"timestamp"`

	// The identifier of the member.
	Id *string `type:"string"`

	// The name of the member.
	Name *string `type:"string"`

	// The state of the member, which can be ENABLED, DISABLED, or DELETED.
	State *string `type:"string" enum:"EntityState"`

	// A member can be a user or group.
	Type *string `type:"string" enum:"MemberType"`
	// contains filtered or unexported fields
}

The representation of a user or group.

func (Member) GoString 

func (s Member) GoString() string

GoString returns the string representation

func (*Member) SetDisabledDate 

func (s *Member) SetDisabledDate(v time.Time) *Member

SetDisabledDate sets the DisabledDate field's value.

func (*Member) SetEnabledDate 

func (s *Member) SetEnabledDate(v time.Time) *Member

SetEnabledDate sets the EnabledDate field's value.

func (*Member) SetId 

func (s *Member) SetId(v string) *Member

SetId sets the Id field's value.

func (*Member) SetName 

func (s *Member) SetName(v string) *Member

SetName sets the Name field's value.

func (*Member) SetState 

func (s *Member) SetState(v string) *Member

SetState sets the State field's value.

func (*Member) SetType 

func (s *Member) SetType(v string) *Member

SetType sets the Type field's value.

func (Member) String 

func (s Member) String() string

String returns the string representation

type MobileDeviceAccessMatchedRule added in v1.38.10 

type MobileDeviceAccessMatchedRule struct {

	// Identifier of the rule that a simulated user matches.
	MobileDeviceAccessRuleId *string `min:"1" type:"string"`

	// Name of a rule that a simulated user matches.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The rule that a simulated user matches.

func (MobileDeviceAccessMatchedRule) GoString added in v1.38.10 

func (s MobileDeviceAccessMatchedRule) GoString() string

GoString returns the string representation

func (*MobileDeviceAccessMatchedRule) SetMobileDeviceAccessRuleId added in v1.38.10 

func (s *MobileDeviceAccessMatchedRule) SetMobileDeviceAccessRuleId(v string) *MobileDeviceAccessMatchedRule

SetMobileDeviceAccessRuleId sets the MobileDeviceAccessRuleId field's value.

func (*MobileDeviceAccessMatchedRule) SetName added in v1.38.10 

func (s *MobileDeviceAccessMatchedRule) SetName(v string) *MobileDeviceAccessMatchedRule

SetName sets the Name field's value.

func (MobileDeviceAccessMatchedRule) String added in v1.38.10 

func (s MobileDeviceAccessMatchedRule) String() string

String returns the string representation

type MobileDeviceAccessRule added in v1.38.10 

type MobileDeviceAccessRule struct {

	// The date and time at which an access rule was created.
	DateCreated *time.Time `type:"timestamp"`

	// The date and time at which an access rule was modified.
	DateModified *time.Time `type:"timestamp"`

	// The description of a mobile access rule.
	Description *string `min:"1" type:"string"`

	// Device models that a rule will match.
	DeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that a rule will match.
	DeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that a rule will match.
	DeviceTypes []*string `min:"1" type:"list"`

	// Device user agents that a rule will match.
	DeviceUserAgents []*string `min:"1" type:"list"`

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY.
	Effect *string `type:"string" enum:"MobileDeviceAccessRuleEffect"`

	// The ID assigned to a mobile access rule.
	MobileDeviceAccessRuleId *string `min:"1" type:"string"`

	// The name of a mobile access rule.
	Name *string `min:"1" type:"string"`

	// Device models that a rule will not match. All other device models will match.
	NotDeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that a rule will not match. All other device types
	// will match.
	NotDeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that a rule will not match. All other device types will match.
	NotDeviceTypes []*string `min:"1" type:"list"`

	// Device user agents that a rule will not match. All other device user agents
	// will match.
	NotDeviceUserAgents []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A rule that controls access to mobile devices for an Amazon WorkMail group.

func (MobileDeviceAccessRule) GoString added in v1.38.10 

func (s MobileDeviceAccessRule) GoString() string

GoString returns the string representation

func (*MobileDeviceAccessRule) SetDateCreated added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDateCreated(v time.Time) *MobileDeviceAccessRule

SetDateCreated sets the DateCreated field's value.

func (*MobileDeviceAccessRule) SetDateModified added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDateModified(v time.Time) *MobileDeviceAccessRule

SetDateModified sets the DateModified field's value.

func (*MobileDeviceAccessRule) SetDescription added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDescription(v string) *MobileDeviceAccessRule

SetDescription sets the Description field's value.

func (*MobileDeviceAccessRule) SetDeviceModels added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDeviceModels(v []*string) *MobileDeviceAccessRule

SetDeviceModels sets the DeviceModels field's value.

func (*MobileDeviceAccessRule) SetDeviceOperatingSystems added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDeviceOperatingSystems(v []*string) *MobileDeviceAccessRule

SetDeviceOperatingSystems sets the DeviceOperatingSystems field's value.

func (*MobileDeviceAccessRule) SetDeviceTypes added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDeviceTypes(v []*string) *MobileDeviceAccessRule

SetDeviceTypes sets the DeviceTypes field's value.

func (*MobileDeviceAccessRule) SetDeviceUserAgents added in v1.38.10 

func (s *MobileDeviceAccessRule) SetDeviceUserAgents(v []*string) *MobileDeviceAccessRule

SetDeviceUserAgents sets the DeviceUserAgents field's value.

func (*MobileDeviceAccessRule) SetEffect added in v1.38.10 

func (s *MobileDeviceAccessRule) SetEffect(v string) *MobileDeviceAccessRule

SetEffect sets the Effect field's value.

func (*MobileDeviceAccessRule) SetMobileDeviceAccessRuleId added in v1.38.10 

func (s *MobileDeviceAccessRule) SetMobileDeviceAccessRuleId(v string) *MobileDeviceAccessRule

SetMobileDeviceAccessRuleId sets the MobileDeviceAccessRuleId field's value.

func (*MobileDeviceAccessRule) SetName added in v1.38.10 

func (s *MobileDeviceAccessRule) SetName(v string) *MobileDeviceAccessRule

SetName sets the Name field's value.

func (*MobileDeviceAccessRule) SetNotDeviceModels added in v1.38.10 

func (s *MobileDeviceAccessRule) SetNotDeviceModels(v []*string) *MobileDeviceAccessRule

SetNotDeviceModels sets the NotDeviceModels field's value.

func (*MobileDeviceAccessRule) SetNotDeviceOperatingSystems added in v1.38.10 

func (s *MobileDeviceAccessRule) SetNotDeviceOperatingSystems(v []*string) *MobileDeviceAccessRule

SetNotDeviceOperatingSystems sets the NotDeviceOperatingSystems field's value.

func (*MobileDeviceAccessRule) SetNotDeviceTypes added in v1.38.10 

func (s *MobileDeviceAccessRule) SetNotDeviceTypes(v []*string) *MobileDeviceAccessRule

SetNotDeviceTypes sets the NotDeviceTypes field's value.

func (*MobileDeviceAccessRule) SetNotDeviceUserAgents added in v1.38.10 

func (s *MobileDeviceAccessRule) SetNotDeviceUserAgents(v []*string) *MobileDeviceAccessRule

SetNotDeviceUserAgents sets the NotDeviceUserAgents field's value.

func (MobileDeviceAccessRule) String added in v1.38.10 

func (s MobileDeviceAccessRule) String() string

String returns the string representation

type NameAvailabilityException added in v1.28.0 

type NameAvailabilityException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The user, group, or resource name isn't unique in Amazon WorkMail.

func (*NameAvailabilityException) Code added in v1.28.0 

func (s *NameAvailabilityException) Code() string

Code returns the exception type name.

func (*NameAvailabilityException) Error added in v1.28.0 

func (s *NameAvailabilityException) Error() string

func (NameAvailabilityException) GoString added in v1.28.0 

func (s NameAvailabilityException) GoString() string

GoString returns the string representation

func (*NameAvailabilityException) Message added in v1.28.0 

func (s *NameAvailabilityException) Message() string

Message returns the exception's message.

func (*NameAvailabilityException) OrigErr added in v1.28.0 

func (s *NameAvailabilityException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NameAvailabilityException) RequestID added in v1.28.0 

func (s *NameAvailabilityException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NameAvailabilityException) StatusCode added in v1.28.0 

func (s *NameAvailabilityException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NameAvailabilityException) String added in v1.28.0 

func (s NameAvailabilityException) String() string

String returns the string representation

type OrganizationNotFoundException added in v1.28.0 

type OrganizationNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An operation received a valid organization identifier that either doesn't belong or exist in the system.

func (*OrganizationNotFoundException) Code added in v1.28.0 

func (s *OrganizationNotFoundException) Code() string

Code returns the exception type name.

func (*OrganizationNotFoundException) Error added in v1.28.0 

func (s *OrganizationNotFoundException) Error() string

func (OrganizationNotFoundException) GoString added in v1.28.0 

func (s OrganizationNotFoundException) GoString() string

GoString returns the string representation

func (*OrganizationNotFoundException) Message added in v1.28.0 

func (s *OrganizationNotFoundException) Message() string

Message returns the exception's message.

func (*OrganizationNotFoundException) OrigErr added in v1.28.0 

func (s *OrganizationNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OrganizationNotFoundException) RequestID added in v1.28.0 

func (s *OrganizationNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OrganizationNotFoundException) StatusCode added in v1.28.0 

func (s *OrganizationNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OrganizationNotFoundException) String added in v1.28.0 

func (s OrganizationNotFoundException) String() string

String returns the string representation

type OrganizationStateException added in v1.28.0 

type OrganizationStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The organization must have a valid state to perform certain operations on the organization or its members.

func (*OrganizationStateException) Code added in v1.28.0 

func (s *OrganizationStateException) Code() string

Code returns the exception type name.

func (*OrganizationStateException) Error added in v1.28.0 

func (s *OrganizationStateException) Error() string

func (OrganizationStateException) GoString added in v1.28.0 

func (s OrganizationStateException) GoString() string

GoString returns the string representation

func (*OrganizationStateException) Message added in v1.28.0 

func (s *OrganizationStateException) Message() string

Message returns the exception's message.

func (*OrganizationStateException) OrigErr added in v1.28.0 

func (s *OrganizationStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OrganizationStateException) RequestID added in v1.28.0 

func (s *OrganizationStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OrganizationStateException) StatusCode added in v1.28.0 

func (s *OrganizationStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OrganizationStateException) String added in v1.28.0 

func (s OrganizationStateException) String() string

String returns the string representation

type OrganizationSummary 

type OrganizationSummary struct {

	// The alias associated with the organization.
	Alias *string `min:"1" type:"string"`

	// The default email domain associated with the organization.
	DefaultMailDomain *string `min:"3" type:"string"`

	// The error message associated with the organization. It is only present if
	// unexpected behavior has occurred with regards to the organization. It provides
	// insight or solutions regarding unexpected behavior.
	ErrorMessage *string `type:"string"`

	// The identifier associated with the organization.
	OrganizationId *string `min:"34" type:"string"`

	// The state associated with the organization.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

The representation of an organization.

func (OrganizationSummary) GoString 

func (s OrganizationSummary) GoString() string

GoString returns the string representation

func (*OrganizationSummary) SetAlias 

func (s *OrganizationSummary) SetAlias(v string) *OrganizationSummary

SetAlias sets the Alias field's value.

func (*OrganizationSummary) SetDefaultMailDomain added in v1.35.8 

func (s *OrganizationSummary) SetDefaultMailDomain(v string) *OrganizationSummary

SetDefaultMailDomain sets the DefaultMailDomain field's value.

func (*OrganizationSummary) SetErrorMessage 

func (s *OrganizationSummary) SetErrorMessage(v string) *OrganizationSummary

SetErrorMessage sets the ErrorMessage field's value.

func (*OrganizationSummary) SetOrganizationId 

func (s *OrganizationSummary) SetOrganizationId(v string) *OrganizationSummary

SetOrganizationId sets the OrganizationId field's value.

func (*OrganizationSummary) SetState 

func (s *OrganizationSummary) SetState(v string) *OrganizationSummary

SetState sets the State field's value.

func (OrganizationSummary) String 

func (s OrganizationSummary) String() string

String returns the string representation

type Permission added in v1.13.32 

type Permission struct {

	// The identifier of the user, group, or resource to which the permissions are
	// granted.
	//
	// GranteeId is a required field
	GranteeId *string `min:"12" type:"string" required:"true"`

	// The type of user, group, or resource referred to in GranteeId.
	//
	// GranteeType is a required field
	GranteeType *string `type:"string" required:"true" enum:"MemberType"`

	// 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.
	//
	// PermissionValues is a required field
	PermissionValues []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

func (Permission) GoString added in v1.13.32 

func (s Permission) GoString() string

GoString returns the string representation

func (*Permission) SetGranteeId added in v1.13.32 

func (s *Permission) SetGranteeId(v string) *Permission

SetGranteeId sets the GranteeId field's value.

func (*Permission) SetGranteeType added in v1.13.32 

func (s *Permission) SetGranteeType(v string) *Permission

SetGranteeType sets the GranteeType field's value.

func (*Permission) SetPermissionValues added in v1.13.32 

func (s *Permission) SetPermissionValues(v []*string) *Permission

SetPermissionValues sets the PermissionValues field's value.

func (Permission) String added in v1.13.32 

func (s Permission) String() string

String returns the string representation

type PutAccessControlRuleInput added in v1.29.1 

type PutAccessControlRuleInput struct {

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

	// The rule description.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The rule effect.
	//
	// Effect is a required field
	Effect *string `type:"string" required:"true" enum:"AccessControlRuleEffect"`

	// IPv4 CIDR ranges to include in the rule.
	IpRanges []*string `type:"list"`

	// The rule name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

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

	// IPv4 CIDR ranges to exclude from the rule.
	NotIpRanges []*string `type:"list"`

	// User IDs to exclude from the rule.
	NotUserIds []*string `type:"list"`

	// The identifier of the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// User IDs to include in the rule.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (PutAccessControlRuleInput) GoString added in v1.29.1 

func (s PutAccessControlRuleInput) GoString() string

GoString returns the string representation

func (*PutAccessControlRuleInput) SetActions added in v1.29.1 

func (s *PutAccessControlRuleInput) SetActions(v []*string) *PutAccessControlRuleInput

SetActions sets the Actions field's value.

func (*PutAccessControlRuleInput) SetDescription added in v1.29.1 

func (s *PutAccessControlRuleInput) SetDescription(v string) *PutAccessControlRuleInput

SetDescription sets the Description field's value.

func (*PutAccessControlRuleInput) SetEffect added in v1.29.1 

func (s *PutAccessControlRuleInput) SetEffect(v string) *PutAccessControlRuleInput

SetEffect sets the Effect field's value.

func (*PutAccessControlRuleInput) SetIpRanges added in v1.29.1 

func (s *PutAccessControlRuleInput) SetIpRanges(v []*string) *PutAccessControlRuleInput

SetIpRanges sets the IpRanges field's value.

func (*PutAccessControlRuleInput) SetName added in v1.29.1 

func (s *PutAccessControlRuleInput) SetName(v string) *PutAccessControlRuleInput

SetName sets the Name field's value.

func (*PutAccessControlRuleInput) SetNotActions added in v1.29.1 

func (s *PutAccessControlRuleInput) SetNotActions(v []*string) *PutAccessControlRuleInput

SetNotActions sets the NotActions field's value.

func (*PutAccessControlRuleInput) SetNotIpRanges added in v1.29.1 

func (s *PutAccessControlRuleInput) SetNotIpRanges(v []*string) *PutAccessControlRuleInput

SetNotIpRanges sets the NotIpRanges field's value.

func (*PutAccessControlRuleInput) SetNotUserIds added in v1.29.1 

func (s *PutAccessControlRuleInput) SetNotUserIds(v []*string) *PutAccessControlRuleInput

SetNotUserIds sets the NotUserIds field's value.

func (*PutAccessControlRuleInput) SetOrganizationId added in v1.29.1 

func (s *PutAccessControlRuleInput) SetOrganizationId(v string) *PutAccessControlRuleInput

SetOrganizationId sets the OrganizationId field's value.

func (*PutAccessControlRuleInput) SetUserIds added in v1.29.1 

func (s *PutAccessControlRuleInput) SetUserIds(v []*string) *PutAccessControlRuleInput

SetUserIds sets the UserIds field's value.

func (PutAccessControlRuleInput) String added in v1.29.1 

func (s PutAccessControlRuleInput) String() string

String returns the string representation

func (*PutAccessControlRuleInput) Validate added in v1.29.1 

func (s *PutAccessControlRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAccessControlRuleOutput added in v1.29.1 

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

func (PutAccessControlRuleOutput) GoString added in v1.29.1 

func (s PutAccessControlRuleOutput) GoString() string

GoString returns the string representation

func (PutAccessControlRuleOutput) String added in v1.29.1 

func (s PutAccessControlRuleOutput) String() string

String returns the string representation

type PutMailboxPermissionsInput added in v1.13.32 

type PutMailboxPermissionsInput struct {

	// The identifier of the user, group, or resource for which to update mailbox
	// permissions.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier of the user, group, or resource to which to grant the permissions.
	//
	// GranteeId is a required field
	GranteeId *string `min:"12" type:"string" required:"true"`

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// 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.
	//
	// PermissionValues is a required field
	PermissionValues []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutMailboxPermissionsInput) GoString added in v1.13.32 

func (s PutMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*PutMailboxPermissionsInput) SetEntityId added in v1.13.32 

func (s *PutMailboxPermissionsInput) SetEntityId(v string) *PutMailboxPermissionsInput

SetEntityId sets the EntityId field's value.

func (*PutMailboxPermissionsInput) SetGranteeId added in v1.13.32 

func (s *PutMailboxPermissionsInput) SetGranteeId(v string) *PutMailboxPermissionsInput

SetGranteeId sets the GranteeId field's value.

func (*PutMailboxPermissionsInput) SetOrganizationId added in v1.13.32 

func (s *PutMailboxPermissionsInput) SetOrganizationId(v string) *PutMailboxPermissionsInput

SetOrganizationId sets the OrganizationId field's value.

func (*PutMailboxPermissionsInput) SetPermissionValues added in v1.13.32 

func (s *PutMailboxPermissionsInput) SetPermissionValues(v []*string) *PutMailboxPermissionsInput

SetPermissionValues sets the PermissionValues field's value.

func (PutMailboxPermissionsInput) String added in v1.13.32 

func (s PutMailboxPermissionsInput) String() string

String returns the string representation

func (*PutMailboxPermissionsInput) Validate added in v1.13.32 

func (s *PutMailboxPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutMailboxPermissionsOutput added in v1.13.32 

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

func (PutMailboxPermissionsOutput) GoString added in v1.13.32 

func (s PutMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (PutMailboxPermissionsOutput) String added in v1.13.32 

func (s PutMailboxPermissionsOutput) String() string

String returns the string representation

type PutRetentionPolicyInput added in v1.31.7 

type PutRetentionPolicyInput struct {

	// The retention policy description.
	Description *string `type:"string" sensitive:"true"`

	// The retention policy folder configurations.
	//
	// FolderConfigurations is a required field
	FolderConfigurations []*FolderConfiguration `type:"list" required:"true"`

	// The retention policy ID.
	Id *string `min:"1" type:"string"`

	// The retention policy name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The organization ID.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutRetentionPolicyInput) GoString added in v1.31.7 

func (s PutRetentionPolicyInput) GoString() string

GoString returns the string representation

func (*PutRetentionPolicyInput) SetDescription added in v1.31.7 

func (s *PutRetentionPolicyInput) SetDescription(v string) *PutRetentionPolicyInput

SetDescription sets the Description field's value.

func (*PutRetentionPolicyInput) SetFolderConfigurations added in v1.31.7 

func (s *PutRetentionPolicyInput) SetFolderConfigurations(v []*FolderConfiguration) *PutRetentionPolicyInput

SetFolderConfigurations sets the FolderConfigurations field's value.

func (*PutRetentionPolicyInput) SetId added in v1.31.7 

func (s *PutRetentionPolicyInput) SetId(v string) *PutRetentionPolicyInput

SetId sets the Id field's value.

func (*PutRetentionPolicyInput) SetName added in v1.31.7 

func (s *PutRetentionPolicyInput) SetName(v string) *PutRetentionPolicyInput

SetName sets the Name field's value.

func (*PutRetentionPolicyInput) SetOrganizationId added in v1.31.7 

func (s *PutRetentionPolicyInput) SetOrganizationId(v string) *PutRetentionPolicyInput

SetOrganizationId sets the OrganizationId field's value.

func (PutRetentionPolicyInput) String added in v1.31.7 

func (s PutRetentionPolicyInput) String() string

String returns the string representation

func (*PutRetentionPolicyInput) Validate added in v1.31.7 

func (s *PutRetentionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRetentionPolicyOutput added in v1.31.7 

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

func (PutRetentionPolicyOutput) GoString added in v1.31.7 

func (s PutRetentionPolicyOutput) GoString() string

GoString returns the string representation

func (PutRetentionPolicyOutput) String added in v1.31.7 

func (s PutRetentionPolicyOutput) String() string

String returns the string representation

type RegisterToWorkMailInput 

type RegisterToWorkMailInput struct {

	// The email for the user, group, or resource to be updated.
	//
	// Email is a required field
	Email *string `min:"1" type:"string" required:"true"`

	// The identifier for the user, group, or resource to be updated.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The identifier for the organization under which the user, group, or resource
	// exists.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterToWorkMailInput) GoString 

func (s RegisterToWorkMailInput) GoString() string

GoString returns the string representation

func (*RegisterToWorkMailInput) SetEmail 

func (s *RegisterToWorkMailInput) SetEmail(v string) *RegisterToWorkMailInput

SetEmail sets the Email field's value.

func (*RegisterToWorkMailInput) SetEntityId 

func (s *RegisterToWorkMailInput) SetEntityId(v string) *RegisterToWorkMailInput

SetEntityId sets the EntityId field's value.

func (*RegisterToWorkMailInput) SetOrganizationId 

func (s *RegisterToWorkMailInput) SetOrganizationId(v string) *RegisterToWorkMailInput

SetOrganizationId sets the OrganizationId field's value.

func (RegisterToWorkMailInput) String 

func (s RegisterToWorkMailInput) String() string

String returns the string representation

func (*RegisterToWorkMailInput) Validate 

func (s *RegisterToWorkMailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterToWorkMailOutput 

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

func (RegisterToWorkMailOutput) GoString 

func (s RegisterToWorkMailOutput) GoString() string

GoString returns the string representation

func (RegisterToWorkMailOutput) String 

func (s RegisterToWorkMailOutput) String() string

String returns the string representation

type ReservedNameException added in v1.28.0 

type ReservedNameException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This user, group, or resource name is not allowed in Amazon WorkMail.

func (*ReservedNameException) Code added in v1.28.0 

func (s *ReservedNameException) Code() string

Code returns the exception type name.

func (*ReservedNameException) Error added in v1.28.0 

func (s *ReservedNameException) Error() string

func (ReservedNameException) GoString added in v1.28.0 

func (s ReservedNameException) GoString() string

GoString returns the string representation

func (*ReservedNameException) Message added in v1.28.0 

func (s *ReservedNameException) Message() string

Message returns the exception's message.

func (*ReservedNameException) OrigErr added in v1.28.0 

func (s *ReservedNameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ReservedNameException) RequestID added in v1.28.0 

func (s *ReservedNameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ReservedNameException) StatusCode added in v1.28.0 

func (s *ReservedNameException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ReservedNameException) String added in v1.28.0 

func (s ReservedNameException) String() string

String returns the string representation

type ResetPasswordInput 

type ResetPasswordInput struct {

	// The identifier of the organization that contains the user for which the password
	// is reset.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The new password for the user.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"true"`

	// The identifier of the user for whom the password is reset.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResetPasswordInput) GoString 

func (s ResetPasswordInput) GoString() string

GoString returns the string representation

func (*ResetPasswordInput) SetOrganizationId 

func (s *ResetPasswordInput) SetOrganizationId(v string) *ResetPasswordInput

SetOrganizationId sets the OrganizationId field's value.

func (*ResetPasswordInput) SetPassword 

func (s *ResetPasswordInput) SetPassword(v string) *ResetPasswordInput

SetPassword sets the Password field's value.

func (*ResetPasswordInput) SetUserId 

func (s *ResetPasswordInput) SetUserId(v string) *ResetPasswordInput

SetUserId sets the UserId field's value.

func (ResetPasswordInput) String 

func (s ResetPasswordInput) String() string

String returns the string representation

func (*ResetPasswordInput) Validate 

func (s *ResetPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResetPasswordOutput 

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

func (ResetPasswordOutput) GoString 

func (s ResetPasswordOutput) GoString() string

GoString returns the string representation

func (ResetPasswordOutput) String 

func (s ResetPasswordOutput) String() string

String returns the string representation

type Resource 

type Resource struct {

	// The date indicating when the resource was disabled from Amazon WorkMail use.
	DisabledDate *time.Time `type:"timestamp"`

	// The email of the resource.
	Email *string `min:"1" type:"string"`

	// The date indicating when the resource was enabled for Amazon WorkMail use.
	EnabledDate *time.Time `type:"timestamp"`

	// The identifier of the resource.
	Id *string `min:"12" type:"string"`

	// The name of the resource.
	Name *string `min:"1" type:"string"`

	// The state of the resource, which can be ENABLED, DISABLED, or DELETED.
	State *string `type:"string" enum:"EntityState"`

	// The type of the resource: equipment or room.
	Type *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

The representation of a resource.

func (Resource) GoString 

func (s Resource) GoString() string

GoString returns the string representation

func (*Resource) SetDisabledDate 

func (s *Resource) SetDisabledDate(v time.Time) *Resource

SetDisabledDate sets the DisabledDate field's value.

func (*Resource) SetEmail 

func (s *Resource) SetEmail(v string) *Resource

SetEmail sets the Email field's value.

func (*Resource) SetEnabledDate 

func (s *Resource) SetEnabledDate(v time.Time) *Resource

SetEnabledDate sets the EnabledDate field's value.

func (*Resource) SetId 

func (s *Resource) SetId(v string) *Resource

SetId sets the Id field's value.

func (*Resource) SetName 

func (s *Resource) SetName(v string) *Resource

SetName sets the Name field's value.

func (*Resource) SetState 

func (s *Resource) SetState(v string) *Resource

SetState sets the State field's value.

func (*Resource) SetType 

func (s *Resource) SetType(v string) *Resource

SetType sets the Type field's value.

func (Resource) String 

func (s Resource) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.10 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource cannot be found.

func (*ResourceNotFoundException) Code added in v1.28.10 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.10 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.10 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.10 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.10 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.10 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.10 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.10 

func (s ResourceNotFoundException) String() string

String returns the string representation

type StartMailboxExportJobInput added in v1.34.29 

type StartMailboxExportJobInput struct {

	// The idempotency token for the client request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The mailbox export job description.
	Description *string `type:"string"`

	// The identifier of the user or resource associated with the mailbox.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service
	// (AWS KMS) key that encrypts the exported mailbox content.
	//
	// KmsKeyArn is a required field
	KmsKeyArn *string `min:"20" type:"string" required:"true"`

	// The identifier associated with the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The ARN of the AWS Identity and Access Management (IAM) role that grants
	// write permission to the S3 bucket.
	//
	// RoleArn is a required field
	RoleArn *string `min:"20" type:"string" required:"true"`

	// The name of the S3 bucket.
	//
	// S3BucketName is a required field
	S3BucketName *string `min:"1" type:"string" required:"true"`

	// The S3 bucket prefix.
	//
	// S3Prefix is a required field
	S3Prefix *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartMailboxExportJobInput) GoString added in v1.34.29 

func (s StartMailboxExportJobInput) GoString() string

GoString returns the string representation

func (*StartMailboxExportJobInput) SetClientToken added in v1.34.29 

func (s *StartMailboxExportJobInput) SetClientToken(v string) *StartMailboxExportJobInput

SetClientToken sets the ClientToken field's value.

func (*StartMailboxExportJobInput) SetDescription added in v1.34.29 

func (s *StartMailboxExportJobInput) SetDescription(v string) *StartMailboxExportJobInput

SetDescription sets the Description field's value.

func (*StartMailboxExportJobInput) SetEntityId added in v1.34.29 

func (s *StartMailboxExportJobInput) SetEntityId(v string) *StartMailboxExportJobInput

SetEntityId sets the EntityId field's value.

func (*StartMailboxExportJobInput) SetKmsKeyArn added in v1.34.29 

func (s *StartMailboxExportJobInput) SetKmsKeyArn(v string) *StartMailboxExportJobInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*StartMailboxExportJobInput) SetOrganizationId added in v1.34.29 

func (s *StartMailboxExportJobInput) SetOrganizationId(v string) *StartMailboxExportJobInput

SetOrganizationId sets the OrganizationId field's value.

func (*StartMailboxExportJobInput) SetRoleArn added in v1.34.29 

func (s *StartMailboxExportJobInput) SetRoleArn(v string) *StartMailboxExportJobInput

SetRoleArn sets the RoleArn field's value.

func (*StartMailboxExportJobInput) SetS3BucketName added in v1.34.29 

func (s *StartMailboxExportJobInput) SetS3BucketName(v string) *StartMailboxExportJobInput

SetS3BucketName sets the S3BucketName field's value.

func (*StartMailboxExportJobInput) SetS3Prefix added in v1.34.29 

func (s *StartMailboxExportJobInput) SetS3Prefix(v string) *StartMailboxExportJobInput

SetS3Prefix sets the S3Prefix field's value.

func (StartMailboxExportJobInput) String added in v1.34.29 

func (s StartMailboxExportJobInput) String() string

String returns the string representation

func (*StartMailboxExportJobInput) Validate added in v1.34.29 

func (s *StartMailboxExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartMailboxExportJobOutput added in v1.34.29 

type StartMailboxExportJobOutput struct {

	// The job ID.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartMailboxExportJobOutput) GoString added in v1.34.29 

func (s StartMailboxExportJobOutput) GoString() string

GoString returns the string representation

func (*StartMailboxExportJobOutput) SetJobId added in v1.34.29 

func (s *StartMailboxExportJobOutput) SetJobId(v string) *StartMailboxExportJobOutput

SetJobId sets the JobId field's value.

func (StartMailboxExportJobOutput) String added in v1.34.29 

func (s StartMailboxExportJobOutput) String() string

String returns the string representation

type Tag added in v1.28.10 

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a tag applied to a resource.

func (Tag) GoString added in v1.28.10 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.28.10 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.28.10 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.28.10 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.28.10 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.28.10 

type TagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag key-value pairs.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.28.10 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.28.10 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.28.10 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.28.10 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.28.10 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.28.10 

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

func (TagResourceOutput) GoString added in v1.28.10 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.28.10 

func (s TagResourceOutput) String() string

String returns the string representation

type TooManyTagsException added in v1.28.10 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource can have up to 50 user-applied tags.

func (*TooManyTagsException) Code added in v1.28.10 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error added in v1.28.10 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString added in v1.28.10 

func (s TooManyTagsException) GoString() string

GoString returns the string representation

func (*TooManyTagsException) Message added in v1.28.10 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr added in v1.28.10 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID added in v1.28.10 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode added in v1.28.10 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String added in v1.28.10 

func (s TooManyTagsException) String() string

String returns the string representation

type UnsupportedOperationException added in v1.28.0 

type UnsupportedOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You can't perform a write operation against a read-only directory.

func (*UnsupportedOperationException) Code added in v1.28.0 

func (s *UnsupportedOperationException) Code() string

Code returns the exception type name.

func (*UnsupportedOperationException) Error added in v1.28.0 

func (s *UnsupportedOperationException) Error() string

func (UnsupportedOperationException) GoString added in v1.28.0 

func (s UnsupportedOperationException) GoString() string

GoString returns the string representation

func (*UnsupportedOperationException) Message added in v1.28.0 

func (s *UnsupportedOperationException) Message() string

Message returns the exception's message.

func (*UnsupportedOperationException) OrigErr added in v1.28.0 

func (s *UnsupportedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperationException) RequestID added in v1.28.0 

func (s *UnsupportedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperationException) StatusCode added in v1.28.0 

func (s *UnsupportedOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedOperationException) String added in v1.28.0 

func (s UnsupportedOperationException) String() string

String returns the string representation

type UntagResourceInput added in v1.28.10 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.28.10 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.28.10 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.28.10 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.28.10 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.28.10 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.28.10 

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

func (UntagResourceOutput) GoString added in v1.28.10 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.28.10 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateMailboxQuotaInput added in v1.19.24 

type UpdateMailboxQuotaInput struct {

	// The updated mailbox quota, in MB, for the specified user.
	//
	// MailboxQuota is a required field
	MailboxQuota *int64 `min:"1" type:"integer" required:"true"`

	// The identifier for the organization that contains the user for whom to update
	// the mailbox quota.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifer for the user for whom to update the mailbox quota.
	//
	// UserId is a required field
	UserId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMailboxQuotaInput) GoString added in v1.19.24 

func (s UpdateMailboxQuotaInput) GoString() string

GoString returns the string representation

func (*UpdateMailboxQuotaInput) SetMailboxQuota added in v1.19.24 

func (s *UpdateMailboxQuotaInput) SetMailboxQuota(v int64) *UpdateMailboxQuotaInput

SetMailboxQuota sets the MailboxQuota field's value.

func (*UpdateMailboxQuotaInput) SetOrganizationId added in v1.19.24 

func (s *UpdateMailboxQuotaInput) SetOrganizationId(v string) *UpdateMailboxQuotaInput

SetOrganizationId sets the OrganizationId field's value.

func (*UpdateMailboxQuotaInput) SetUserId added in v1.19.24 

func (s *UpdateMailboxQuotaInput) SetUserId(v string) *UpdateMailboxQuotaInput

SetUserId sets the UserId field's value.

func (UpdateMailboxQuotaInput) String added in v1.19.24 

func (s UpdateMailboxQuotaInput) String() string

String returns the string representation

func (*UpdateMailboxQuotaInput) Validate added in v1.19.24 

func (s *UpdateMailboxQuotaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMailboxQuotaOutput added in v1.19.24 

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

func (UpdateMailboxQuotaOutput) GoString added in v1.19.24 

func (s UpdateMailboxQuotaOutput) GoString() string

GoString returns the string representation

func (UpdateMailboxQuotaOutput) String added in v1.19.24 

func (s UpdateMailboxQuotaOutput) String() string

String returns the string representation

type UpdateMobileDeviceAccessRuleInput added in v1.38.10 

type UpdateMobileDeviceAccessRuleInput struct {

	// The updated rule description.
	Description *string `min:"1" type:"string"`

	// Device models that the updated rule will match.
	DeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that the updated rule will match.
	DeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that the updated rule will match.
	DeviceTypes []*string `min:"1" type:"list"`

	// User agents that the updated rule will match.
	DeviceUserAgents []*string `min:"1" type:"list"`

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY.
	//
	// Effect is a required field
	Effect *string `type:"string" required:"true" enum:"MobileDeviceAccessRuleEffect"`

	// The identifier of the rule to be updated.
	//
	// MobileDeviceAccessRuleId is a required field
	MobileDeviceAccessRuleId *string `min:"1" type:"string" required:"true"`

	// The updated rule name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Device models that the updated rule will not match. All other device models
	// will match.
	NotDeviceModels []*string `min:"1" type:"list"`

	// Device operating systems that the updated rule will not match. All other
	// device operating systems will match.
	NotDeviceOperatingSystems []*string `min:"1" type:"list"`

	// Device types that the updated rule will not match. All other device types
	// will match.
	NotDeviceTypes []*string `min:"1" type:"list"`

	// User agents that the updated rule will not match. All other user agents will
	// match.
	NotDeviceUserAgents []*string `min:"1" type:"list"`

	// The Amazon WorkMail organization under which the rule will be updated.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMobileDeviceAccessRuleInput) GoString added in v1.38.10 

func (s UpdateMobileDeviceAccessRuleInput) GoString() string

GoString returns the string representation

func (*UpdateMobileDeviceAccessRuleInput) SetDescription added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetDescription(v string) *UpdateMobileDeviceAccessRuleInput

SetDescription sets the Description field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetDeviceModels added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetDeviceModels(v []*string) *UpdateMobileDeviceAccessRuleInput

SetDeviceModels sets the DeviceModels field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetDeviceOperatingSystems added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetDeviceOperatingSystems(v []*string) *UpdateMobileDeviceAccessRuleInput

SetDeviceOperatingSystems sets the DeviceOperatingSystems field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetDeviceTypes added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetDeviceTypes(v []*string) *UpdateMobileDeviceAccessRuleInput

SetDeviceTypes sets the DeviceTypes field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetDeviceUserAgents added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetDeviceUserAgents(v []*string) *UpdateMobileDeviceAccessRuleInput

SetDeviceUserAgents sets the DeviceUserAgents field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetEffect added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetEffect(v string) *UpdateMobileDeviceAccessRuleInput

SetEffect sets the Effect field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetMobileDeviceAccessRuleId added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetMobileDeviceAccessRuleId(v string) *UpdateMobileDeviceAccessRuleInput

SetMobileDeviceAccessRuleId sets the MobileDeviceAccessRuleId field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetName added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetName(v string) *UpdateMobileDeviceAccessRuleInput

SetName sets the Name field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetNotDeviceModels added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetNotDeviceModels(v []*string) *UpdateMobileDeviceAccessRuleInput

SetNotDeviceModels sets the NotDeviceModels field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetNotDeviceOperatingSystems added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetNotDeviceOperatingSystems(v []*string) *UpdateMobileDeviceAccessRuleInput

SetNotDeviceOperatingSystems sets the NotDeviceOperatingSystems field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetNotDeviceTypes added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetNotDeviceTypes(v []*string) *UpdateMobileDeviceAccessRuleInput

SetNotDeviceTypes sets the NotDeviceTypes field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetNotDeviceUserAgents added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetNotDeviceUserAgents(v []*string) *UpdateMobileDeviceAccessRuleInput

SetNotDeviceUserAgents sets the NotDeviceUserAgents field's value.

func (*UpdateMobileDeviceAccessRuleInput) SetOrganizationId added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) SetOrganizationId(v string) *UpdateMobileDeviceAccessRuleInput

SetOrganizationId sets the OrganizationId field's value.

func (UpdateMobileDeviceAccessRuleInput) String added in v1.38.10 

func (s UpdateMobileDeviceAccessRuleInput) String() string

String returns the string representation

func (*UpdateMobileDeviceAccessRuleInput) Validate added in v1.38.10 

func (s *UpdateMobileDeviceAccessRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMobileDeviceAccessRuleOutput added in v1.38.10 

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

func (UpdateMobileDeviceAccessRuleOutput) GoString added in v1.38.10 

func (s UpdateMobileDeviceAccessRuleOutput) GoString() string

GoString returns the string representation

func (UpdateMobileDeviceAccessRuleOutput) String added in v1.38.10 

func (s UpdateMobileDeviceAccessRuleOutput) String() string

String returns the string representation

type UpdatePrimaryEmailAddressInput 

type UpdatePrimaryEmailAddressInput struct {

	// The value of the email to be updated as primary.
	//
	// Email is a required field
	Email *string `min:"1" type:"string" required:"true"`

	// The user, group, or resource to update.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

	// The organization that contains the user, group, or resource to update.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePrimaryEmailAddressInput) GoString 

func (s UpdatePrimaryEmailAddressInput) GoString() string

GoString returns the string representation

func (*UpdatePrimaryEmailAddressInput) SetEmail 

func (s *UpdatePrimaryEmailAddressInput) SetEmail(v string) *UpdatePrimaryEmailAddressInput

SetEmail sets the Email field's value.

func (*UpdatePrimaryEmailAddressInput) SetEntityId 

func (s *UpdatePrimaryEmailAddressInput) SetEntityId(v string) *UpdatePrimaryEmailAddressInput

SetEntityId sets the EntityId field's value.

func (*UpdatePrimaryEmailAddressInput) SetOrganizationId 

func (s *UpdatePrimaryEmailAddressInput) SetOrganizationId(v string) *UpdatePrimaryEmailAddressInput

SetOrganizationId sets the OrganizationId field's value.

func (UpdatePrimaryEmailAddressInput) String 

func (s UpdatePrimaryEmailAddressInput) String() string

String returns the string representation

func (*UpdatePrimaryEmailAddressInput) Validate 

func (s *UpdatePrimaryEmailAddressInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePrimaryEmailAddressOutput 

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

func (UpdatePrimaryEmailAddressOutput) GoString 

func (s UpdatePrimaryEmailAddressOutput) GoString() string

GoString returns the string representation

func (UpdatePrimaryEmailAddressOutput) String 

func (s UpdatePrimaryEmailAddressOutput) String() string

String returns the string representation

type UpdateResourceInput 

type UpdateResourceInput struct {

	// The resource's booking options to be updated.
	BookingOptions *BookingOptions `type:"structure"`

	// The name of the resource to be updated.
	Name *string `min:"1" type:"string"`

	// The identifier associated with the organization for which the resource is
	// updated.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"34" type:"string" required:"true"`

	// The identifier of the resource to be updated.
	//
	// ResourceId is a required field
	ResourceId *string `min:"34" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateResourceInput) GoString 

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (*UpdateResourceInput) SetBookingOptions 

func (s *UpdateResourceInput) SetBookingOptions(v *BookingOptions) *UpdateResourceInput

SetBookingOptions sets the BookingOptions field's value.

func (*UpdateResourceInput) SetName 

func (s *UpdateResourceInput) SetName(v string) *UpdateResourceInput

SetName sets the Name field's value.

func (*UpdateResourceInput) SetOrganizationId 

func (s *UpdateResourceInput) SetOrganizationId(v string) *UpdateResourceInput

SetOrganizationId sets the OrganizationId field's value.

func (*UpdateResourceInput) SetResourceId 

func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput

SetResourceId sets the ResourceId field's value.

func (UpdateResourceInput) String 

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate 

func (s *UpdateResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateResourceOutput 

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

func (UpdateResourceOutput) GoString 

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) String 

func (s UpdateResourceOutput) String() string

String returns the string representation

type User 

type User struct {

	// The date indicating when the user was disabled from Amazon WorkMail use.
	DisabledDate *time.Time `type:"timestamp"`

	// The display name of the user.
	DisplayName *string `type:"string"`

	// The email of the user.
	Email *string `min:"1" type:"string"`

	// The date indicating when the user was enabled for Amazon WorkMail use.
	EnabledDate *time.Time `type:"timestamp"`

	// The identifier of the user.
	Id *string `min:"12" type:"string"`

	// The name of the user.
	Name *string `min:"1" type:"string"`

	// The state of the user, which can be ENABLED, DISABLED, or DELETED.
	State *string `type:"string" enum:"EntityState"`

	// The role of the user.
	UserRole *string `type:"string" enum:"UserRole"`
	// contains filtered or unexported fields
}

The representation of an Amazon WorkMail user.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation

func (*User) SetDisabledDate 

func (s *User) SetDisabledDate(v time.Time) *User

SetDisabledDate sets the DisabledDate field's value.

func (*User) SetDisplayName 

func (s *User) SetDisplayName(v string) *User

SetDisplayName sets the DisplayName field's value.

func (*User) SetEmail 

func (s *User) SetEmail(v string) *User

SetEmail sets the Email field's value.

func (*User) SetEnabledDate 

func (s *User) SetEnabledDate(v time.Time) *User

SetEnabledDate sets the EnabledDate field's value.

func (*User) SetId 

func (s *User) SetId(v string) *User

SetId sets the Id field's value.

func (*User) SetName 

func (s *User) SetName(v string) *User

SetName sets the Name field's value.

func (*User) SetState 

func (s *User) SetState(v string) *User

SetState sets the State field's value.

func (*User) SetUserRole 

func (s *User) SetUserRole(v string) *User

SetUserRole sets the UserRole field's value.

func (User) String 

func (s User) String() string

String returns the string representation

type WorkMail 

type WorkMail struct {
	*client.Client
}

WorkMail provides the API operation methods for making requests to Amazon WorkMail. See this package's package overview docs for details on the service.

WorkMail methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkMail

New creates a new instance of the WorkMail client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a WorkMail client from just a session.
svc := workmail.New(mySession)

// Create a WorkMail client with additional configuration
svc := workmail.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*WorkMail) AssociateDelegateToResource 

func (c *WorkMail) AssociateDelegateToResource(input *AssociateDelegateToResourceInput) (*AssociateDelegateToResourceOutput, error)

AssociateDelegateToResource API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation AssociateDelegateToResource for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResource

func (*WorkMail) AssociateDelegateToResourceRequest 

func (c *WorkMail) AssociateDelegateToResourceRequest(input *AssociateDelegateToResourceInput) (req *request.Request, output *AssociateDelegateToResourceOutput)

AssociateDelegateToResourceRequest generates a "aws/request.Request" representing the client's request for the AssociateDelegateToResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateDelegateToResource for more information on using the AssociateDelegateToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateDelegateToResourceRequest method.
req, resp := client.AssociateDelegateToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResource

func (*WorkMail) AssociateDelegateToResourceWithContext 

func (c *WorkMail) AssociateDelegateToResourceWithContext(ctx aws.Context, input *AssociateDelegateToResourceInput, opts ...request.Option) (*AssociateDelegateToResourceOutput, error)

AssociateDelegateToResourceWithContext is the same as AssociateDelegateToResource with the addition of the ability to pass a context and additional request options.

See AssociateDelegateToResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) AssociateMemberToGroup 

func (c *WorkMail) AssociateMemberToGroup(input *AssociateMemberToGroupInput) (*AssociateMemberToGroupOutput, error)

AssociateMemberToGroup API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation AssociateMemberToGroup for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroup

func (*WorkMail) AssociateMemberToGroupRequest 

func (c *WorkMail) AssociateMemberToGroupRequest(input *AssociateMemberToGroupInput) (req *request.Request, output *AssociateMemberToGroupOutput)

AssociateMemberToGroupRequest generates a "aws/request.Request" representing the client's request for the AssociateMemberToGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateMemberToGroup for more information on using the AssociateMemberToGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateMemberToGroupRequest method.
req, resp := client.AssociateMemberToGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroup

func (*WorkMail) AssociateMemberToGroupWithContext 

func (c *WorkMail) AssociateMemberToGroupWithContext(ctx aws.Context, input *AssociateMemberToGroupInput, opts ...request.Option) (*AssociateMemberToGroupOutput, error)

AssociateMemberToGroupWithContext is the same as AssociateMemberToGroup with the addition of the ability to pass a context and additional request options.

See AssociateMemberToGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CancelMailboxExportJob added in v1.34.29 

func (c *WorkMail) CancelMailboxExportJob(input *CancelMailboxExportJobInput) (*CancelMailboxExportJobOutput, error)

CancelMailboxExportJob API operation for Amazon WorkMail.

Cancels a mailbox export job.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CancelMailboxExportJob for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJob

func (*WorkMail) CancelMailboxExportJobRequest added in v1.34.29 

func (c *WorkMail) CancelMailboxExportJobRequest(input *CancelMailboxExportJobInput) (req *request.Request, output *CancelMailboxExportJobOutput)

CancelMailboxExportJobRequest generates a "aws/request.Request" representing the client's request for the CancelMailboxExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelMailboxExportJob for more information on using the CancelMailboxExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelMailboxExportJobRequest method.
req, resp := client.CancelMailboxExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJob

func (*WorkMail) CancelMailboxExportJobWithContext added in v1.34.29 

func (c *WorkMail) CancelMailboxExportJobWithContext(ctx aws.Context, input *CancelMailboxExportJobInput, opts ...request.Option) (*CancelMailboxExportJobOutput, error)

CancelMailboxExportJobWithContext is the same as CancelMailboxExportJob with the addition of the ability to pass a context and additional request options.

See CancelMailboxExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateAlias 

func (c *WorkMail) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)

CreateAlias API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateAlias for usage and error information.

Returned Error Types:

  • EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • MailDomainNotFoundException For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

  • MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • LimitExceededException The request exceeds the limit of the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAlias

func (*WorkMail) CreateAliasRequest 

func (c *WorkMail) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)

CreateAliasRequest generates a "aws/request.Request" representing the client's request for the CreateAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAlias for more information on using the CreateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAliasRequest method.
req, resp := client.CreateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAlias

func (*WorkMail) CreateAliasWithContext 

func (c *WorkMail) CreateAliasWithContext(ctx aws.Context, input *CreateAliasInput, opts ...request.Option) (*CreateAliasOutput, error)

CreateAliasWithContext is the same as CreateAlias with the addition of the ability to pass a context and additional request options.

See CreateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateGroup 

func (c *WorkMail) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateGroup for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • NameAvailabilityException The user, group, or resource name isn't unique in Amazon WorkMail.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • ReservedNameException This user, group, or resource name is not allowed in Amazon WorkMail.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroup

func (*WorkMail) CreateGroupRequest 

func (c *WorkMail) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)

CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGroup for more information on using the CreateGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGroupRequest method.
req, resp := client.CreateGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroup

func (*WorkMail) CreateGroupWithContext 

func (c *WorkMail) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)

CreateGroupWithContext is the same as CreateGroup with the addition of the ability to pass a context and additional request options.

See CreateGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateMobileDeviceAccessRule added in v1.38.10 

func (c *WorkMail) CreateMobileDeviceAccessRule(input *CreateMobileDeviceAccessRuleInput) (*CreateMobileDeviceAccessRuleOutput, error)

CreateMobileDeviceAccessRule API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateMobileDeviceAccessRule for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • LimitExceededException The request exceeds the limit of the resource.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateMobileDeviceAccessRule

func (*WorkMail) CreateMobileDeviceAccessRuleRequest added in v1.38.10 

func (c *WorkMail) CreateMobileDeviceAccessRuleRequest(input *CreateMobileDeviceAccessRuleInput) (req *request.Request, output *CreateMobileDeviceAccessRuleOutput)

CreateMobileDeviceAccessRuleRequest generates a "aws/request.Request" representing the client's request for the CreateMobileDeviceAccessRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMobileDeviceAccessRule for more information on using the CreateMobileDeviceAccessRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateMobileDeviceAccessRuleRequest method.
req, resp := client.CreateMobileDeviceAccessRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateMobileDeviceAccessRule

func (*WorkMail) CreateMobileDeviceAccessRuleWithContext added in v1.38.10 

func (c *WorkMail) CreateMobileDeviceAccessRuleWithContext(ctx aws.Context, input *CreateMobileDeviceAccessRuleInput, opts ...request.Option) (*CreateMobileDeviceAccessRuleOutput, error)

CreateMobileDeviceAccessRuleWithContext is the same as CreateMobileDeviceAccessRule with the addition of the ability to pass a context and additional request options.

See CreateMobileDeviceAccessRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateOrganization added in v1.35.8 

func (c *WorkMail) CreateOrganization(input *CreateOrganizationInput) (*CreateOrganizationOutput, error)

CreateOrganization API operation for Amazon WorkMail.

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html) in the Amazon WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain (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 Amazon WorkMail Administrator Guide.

Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateOrganization for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • DirectoryInUseException The directory is already in use by another WorkMail organization in the same account and Region.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • LimitExceededException The request exceeds the limit of the resource.

  • NameAvailabilityException The user, group, or resource name isn't unique in Amazon WorkMail.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganization

func (*WorkMail) CreateOrganizationRequest added in v1.35.8 

func (c *WorkMail) CreateOrganizationRequest(input *CreateOrganizationInput) (req *request.Request, output *CreateOrganizationOutput)

CreateOrganizationRequest generates a "aws/request.Request" representing the client's request for the CreateOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOrganization for more information on using the CreateOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateOrganizationRequest method.
req, resp := client.CreateOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganization

func (*WorkMail) CreateOrganizationWithContext added in v1.35.8 

func (c *WorkMail) CreateOrganizationWithContext(ctx aws.Context, input *CreateOrganizationInput, opts ...request.Option) (*CreateOrganizationOutput, error)

CreateOrganizationWithContext is the same as CreateOrganization with the addition of the ability to pass a context and additional request options.

See CreateOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateResource 

func (c *WorkMail) CreateResource(input *CreateResourceInput) (*CreateResourceOutput, error)

CreateResource API operation for Amazon WorkMail.

Creates a new Amazon WorkMail resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateResource for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • NameAvailabilityException The user, group, or resource name isn't unique in Amazon WorkMail.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • ReservedNameException This user, group, or resource name is not allowed in Amazon WorkMail.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResource

func (*WorkMail) CreateResourceRequest 

func (c *WorkMail) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *CreateResourceOutput)

CreateResourceRequest generates a "aws/request.Request" representing the client's request for the CreateResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateResource for more information on using the CreateResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateResourceRequest method.
req, resp := client.CreateResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResource

func (*WorkMail) CreateResourceWithContext 

func (c *WorkMail) CreateResourceWithContext(ctx aws.Context, input *CreateResourceInput, opts ...request.Option) (*CreateResourceOutput, error)

CreateResourceWithContext is the same as CreateResource with the addition of the ability to pass a context and additional request options.

See CreateResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) CreateUser 

func (c *WorkMail) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation CreateUser for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • InvalidPasswordException The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

  • NameAvailabilityException The user, group, or resource name isn't unique in Amazon WorkMail.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • ReservedNameException This user, group, or resource name is not allowed in Amazon WorkMail.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUser

func (*WorkMail) CreateUserRequest 

func (c *WorkMail) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUser

func (*WorkMail) CreateUserWithContext 

func (c *WorkMail) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteAccessControlRule added in v1.29.1 

func (c *WorkMail) DeleteAccessControlRule(input *DeleteAccessControlRuleInput) (*DeleteAccessControlRuleOutput, error)

DeleteAccessControlRule API operation for Amazon WorkMail.

Deletes an access control rule for the specified WorkMail organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteAccessControlRule for usage and error information.

Returned Error Types:

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAccessControlRule

func (*WorkMail) DeleteAccessControlRuleRequest added in v1.29.1 

func (c *WorkMail) DeleteAccessControlRuleRequest(input *DeleteAccessControlRuleInput) (req *request.Request, output *DeleteAccessControlRuleOutput)

DeleteAccessControlRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessControlRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccessControlRule for more information on using the DeleteAccessControlRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAccessControlRuleRequest method.
req, resp := client.DeleteAccessControlRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAccessControlRule

func (*WorkMail) DeleteAccessControlRuleWithContext added in v1.29.1 

func (c *WorkMail) DeleteAccessControlRuleWithContext(ctx aws.Context, input *DeleteAccessControlRuleInput, opts ...request.Option) (*DeleteAccessControlRuleOutput, error)

DeleteAccessControlRuleWithContext is the same as DeleteAccessControlRule with the addition of the ability to pass a context and additional request options.

See DeleteAccessControlRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteAlias 

func (c *WorkMail) DeleteAlias(input *DeleteAliasInput) (*DeleteAliasOutput, error)

DeleteAlias API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteAlias for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAlias

func (*WorkMail) DeleteAliasRequest 

func (c *WorkMail) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Request, output *DeleteAliasOutput)

DeleteAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAlias for more information on using the DeleteAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAliasRequest method.
req, resp := client.DeleteAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAlias

func (*WorkMail) DeleteAliasWithContext 

func (c *WorkMail) DeleteAliasWithContext(ctx aws.Context, input *DeleteAliasInput, opts ...request.Option) (*DeleteAliasOutput, error)

DeleteAliasWithContext is the same as DeleteAlias with the addition of the ability to pass a context and additional request options.

See DeleteAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteGroup 

func (c *WorkMail) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for Amazon WorkMail.

Deletes a group from Amazon WorkMail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteGroup for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroup

func (*WorkMail) DeleteGroupRequest 

func (c *WorkMail) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGroup for more information on using the DeleteGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroup

func (*WorkMail) DeleteGroupWithContext 

func (c *WorkMail) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

DeleteGroupWithContext is the same as DeleteGroup with the addition of the ability to pass a context and additional request options.

See DeleteGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteMailboxPermissions added in v1.13.32 

func (c *WorkMail) DeleteMailboxPermissions(input *DeleteMailboxPermissionsInput) (*DeleteMailboxPermissionsOutput, error)

DeleteMailboxPermissions API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteMailboxPermissions for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissions

func (*WorkMail) DeleteMailboxPermissionsRequest added in v1.13.32 

func (c *WorkMail) DeleteMailboxPermissionsRequest(input *DeleteMailboxPermissionsInput) (req *request.Request, output *DeleteMailboxPermissionsOutput)

DeleteMailboxPermissionsRequest generates a "aws/request.Request" representing the client's request for the DeleteMailboxPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMailboxPermissions for more information on using the DeleteMailboxPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteMailboxPermissionsRequest method.
req, resp := client.DeleteMailboxPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissions

func (*WorkMail) DeleteMailboxPermissionsWithContext added in v1.13.32 

func (c *WorkMail) DeleteMailboxPermissionsWithContext(ctx aws.Context, input *DeleteMailboxPermissionsInput, opts ...request.Option) (*DeleteMailboxPermissionsOutput, error)

DeleteMailboxPermissionsWithContext is the same as DeleteMailboxPermissions with the addition of the ability to pass a context and additional request options.

See DeleteMailboxPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteMobileDeviceAccessRule added in v1.38.10 

func (c *WorkMail) DeleteMobileDeviceAccessRule(input *DeleteMobileDeviceAccessRuleInput) (*DeleteMobileDeviceAccessRuleOutput, error)

DeleteMobileDeviceAccessRule API operation for Amazon WorkMail.

Deletes a mobile device access rule for the specified Amazon WorkMail organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteMobileDeviceAccessRule for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessRule

func (*WorkMail) DeleteMobileDeviceAccessRuleRequest added in v1.38.10 

func (c *WorkMail) DeleteMobileDeviceAccessRuleRequest(input *DeleteMobileDeviceAccessRuleInput) (req *request.Request, output *DeleteMobileDeviceAccessRuleOutput)

DeleteMobileDeviceAccessRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteMobileDeviceAccessRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMobileDeviceAccessRule for more information on using the DeleteMobileDeviceAccessRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteMobileDeviceAccessRuleRequest method.
req, resp := client.DeleteMobileDeviceAccessRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessRule

func (*WorkMail) DeleteMobileDeviceAccessRuleWithContext added in v1.38.10 

func (c *WorkMail) DeleteMobileDeviceAccessRuleWithContext(ctx aws.Context, input *DeleteMobileDeviceAccessRuleInput, opts ...request.Option) (*DeleteMobileDeviceAccessRuleOutput, error)

DeleteMobileDeviceAccessRuleWithContext is the same as DeleteMobileDeviceAccessRule with the addition of the ability to pass a context and additional request options.

See DeleteMobileDeviceAccessRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteOrganization added in v1.35.8 

func (c *WorkMail) DeleteOrganization(input *DeleteOrganizationInput) (*DeleteOrganizationOutput, error)

DeleteOrganization API operation for Amazon WorkMail.

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html) in the Amazon WorkMail Administrator Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteOrganization for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganization

func (*WorkMail) DeleteOrganizationRequest added in v1.35.8 

func (c *WorkMail) DeleteOrganizationRequest(input *DeleteOrganizationInput) (req *request.Request, output *DeleteOrganizationOutput)

DeleteOrganizationRequest generates a "aws/request.Request" representing the client's request for the DeleteOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteOrganization for more information on using the DeleteOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteOrganizationRequest method.
req, resp := client.DeleteOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganization

func (*WorkMail) DeleteOrganizationWithContext added in v1.35.8 

func (c *WorkMail) DeleteOrganizationWithContext(ctx aws.Context, input *DeleteOrganizationInput, opts ...request.Option) (*DeleteOrganizationOutput, error)

DeleteOrganizationWithContext is the same as DeleteOrganization with the addition of the ability to pass a context and additional request options.

See DeleteOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteResource 

func (c *WorkMail) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)

DeleteResource API operation for Amazon WorkMail.

Deletes the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteResource for usage and error information.

Returned Error Types:

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResource

func (*WorkMail) DeleteResourceRequest 

func (c *WorkMail) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)

DeleteResourceRequest generates a "aws/request.Request" representing the client's request for the DeleteResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResource for more information on using the DeleteResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteResourceRequest method.
req, resp := client.DeleteResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResource

func (*WorkMail) DeleteResourceWithContext 

func (c *WorkMail) DeleteResourceWithContext(ctx aws.Context, input *DeleteResourceInput, opts ...request.Option) (*DeleteResourceOutput, error)

DeleteResourceWithContext is the same as DeleteResource with the addition of the ability to pass a context and additional request options.

See DeleteResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteRetentionPolicy added in v1.31.7 

func (c *WorkMail) DeleteRetentionPolicy(input *DeleteRetentionPolicyInput) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicy API operation for Amazon WorkMail.

Deletes the specified retention policy from the specified organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteRetentionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicy

func (*WorkMail) DeleteRetentionPolicyRequest added in v1.31.7 

func (c *WorkMail) DeleteRetentionPolicyRequest(input *DeleteRetentionPolicyInput) (req *request.Request, output *DeleteRetentionPolicyOutput)

DeleteRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRetentionPolicy for more information on using the DeleteRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteRetentionPolicyRequest method.
req, resp := client.DeleteRetentionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicy

func (*WorkMail) DeleteRetentionPolicyWithContext added in v1.31.7 

func (c *WorkMail) DeleteRetentionPolicyWithContext(ctx aws.Context, input *DeleteRetentionPolicyInput, opts ...request.Option) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicyWithContext is the same as DeleteRetentionPolicy with the addition of the ability to pass a context and additional request options.

See DeleteRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeleteUser 

func (c *WorkMail) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon WorkMail.

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeleteUser for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUser

func (*WorkMail) DeleteUserRequest 

func (c *WorkMail) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUser

func (*WorkMail) DeleteUserWithContext 

func (c *WorkMail) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DeregisterFromWorkMail 

func (c *WorkMail) DeregisterFromWorkMail(input *DeregisterFromWorkMailInput) (*DeregisterFromWorkMailOutput, error)

DeregisterFromWorkMail API operation for Amazon WorkMail.

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DeregisterFromWorkMail for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMail

func (*WorkMail) DeregisterFromWorkMailRequest 

func (c *WorkMail) DeregisterFromWorkMailRequest(input *DeregisterFromWorkMailInput) (req *request.Request, output *DeregisterFromWorkMailOutput)

DeregisterFromWorkMailRequest generates a "aws/request.Request" representing the client's request for the DeregisterFromWorkMail operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterFromWorkMail for more information on using the DeregisterFromWorkMail API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeregisterFromWorkMailRequest method.
req, resp := client.DeregisterFromWorkMailRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMail

func (*WorkMail) DeregisterFromWorkMailWithContext 

func (c *WorkMail) DeregisterFromWorkMailWithContext(ctx aws.Context, input *DeregisterFromWorkMailInput, opts ...request.Option) (*DeregisterFromWorkMailOutput, error)

DeregisterFromWorkMailWithContext is the same as DeregisterFromWorkMail with the addition of the ability to pass a context and additional request options.

See DeregisterFromWorkMail for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DescribeGroup 

func (c *WorkMail) DescribeGroup(input *DescribeGroupInput) (*DescribeGroupOutput, error)

DescribeGroup API operation for Amazon WorkMail.

Returns the data available for the group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DescribeGroup for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroup

func (*WorkMail) DescribeGroupRequest 

func (c *WorkMail) DescribeGroupRequest(input *DescribeGroupInput) (req *request.Request, output *DescribeGroupOutput)

DescribeGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGroup for more information on using the DescribeGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGroupRequest method.
req, resp := client.DescribeGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroup

func (*WorkMail) DescribeGroupWithContext 

func (c *WorkMail) DescribeGroupWithContext(ctx aws.Context, input *DescribeGroupInput, opts ...request.Option) (*DescribeGroupOutput, error)

DescribeGroupWithContext is the same as DescribeGroup with the addition of the ability to pass a context and additional request options.

See DescribeGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DescribeMailboxExportJob added in v1.34.29 

func (c *WorkMail) DescribeMailboxExportJob(input *DescribeMailboxExportJobInput) (*DescribeMailboxExportJobOutput, error)

DescribeMailboxExportJob API operation for Amazon WorkMail.

Describes the current status of a mailbox export job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DescribeMailboxExportJob for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJob

func (*WorkMail) DescribeMailboxExportJobRequest added in v1.34.29 

func (c *WorkMail) DescribeMailboxExportJobRequest(input *DescribeMailboxExportJobInput) (req *request.Request, output *DescribeMailboxExportJobOutput)

DescribeMailboxExportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeMailboxExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMailboxExportJob for more information on using the DescribeMailboxExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMailboxExportJobRequest method.
req, resp := client.DescribeMailboxExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJob

func (*WorkMail) DescribeMailboxExportJobWithContext added in v1.34.29 

func (c *WorkMail) DescribeMailboxExportJobWithContext(ctx aws.Context, input *DescribeMailboxExportJobInput, opts ...request.Option) (*DescribeMailboxExportJobOutput, error)

DescribeMailboxExportJobWithContext is the same as DescribeMailboxExportJob with the addition of the ability to pass a context and additional request options.

See DescribeMailboxExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DescribeOrganization 

func (c *WorkMail) DescribeOrganization(input *DescribeOrganizationInput) (*DescribeOrganizationOutput, error)

DescribeOrganization API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DescribeOrganization for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganization

func (*WorkMail) DescribeOrganizationRequest 

func (c *WorkMail) DescribeOrganizationRequest(input *DescribeOrganizationInput) (req *request.Request, output *DescribeOrganizationOutput)

DescribeOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOrganization for more information on using the DescribeOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeOrganizationRequest method.
req, resp := client.DescribeOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganization

func (*WorkMail) DescribeOrganizationWithContext 

func (c *WorkMail) DescribeOrganizationWithContext(ctx aws.Context, input *DescribeOrganizationInput, opts ...request.Option) (*DescribeOrganizationOutput, error)

DescribeOrganizationWithContext is the same as DescribeOrganization with the addition of the ability to pass a context and additional request options.

See DescribeOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DescribeResource 

func (c *WorkMail) DescribeResource(input *DescribeResourceInput) (*DescribeResourceOutput, error)

DescribeResource API operation for Amazon WorkMail.

Returns the data available for the resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DescribeResource for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResource

func (*WorkMail) DescribeResourceRequest 

func (c *WorkMail) DescribeResourceRequest(input *DescribeResourceInput) (req *request.Request, output *DescribeResourceOutput)

DescribeResourceRequest generates a "aws/request.Request" representing the client's request for the DescribeResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResource for more information on using the DescribeResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeResourceRequest method.
req, resp := client.DescribeResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResource

func (*WorkMail) DescribeResourceWithContext 

func (c *WorkMail) DescribeResourceWithContext(ctx aws.Context, input *DescribeResourceInput, opts ...request.Option) (*DescribeResourceOutput, error)

DescribeResourceWithContext is the same as DescribeResource with the addition of the ability to pass a context and additional request options.

See DescribeResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DescribeUser 

func (c *WorkMail) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for Amazon WorkMail.

Provides information regarding the user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DescribeUser for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUser

func (*WorkMail) DescribeUserRequest 

func (c *WorkMail) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUser for more information on using the DescribeUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUserRequest method.
req, resp := client.DescribeUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUser

func (*WorkMail) DescribeUserWithContext 

func (c *WorkMail) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.

See DescribeUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DisassociateDelegateFromResource 

func (c *WorkMail) DisassociateDelegateFromResource(input *DisassociateDelegateFromResourceInput) (*DisassociateDelegateFromResourceOutput, error)

DisassociateDelegateFromResource API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DisassociateDelegateFromResource for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResource

func (*WorkMail) DisassociateDelegateFromResourceRequest 

func (c *WorkMail) DisassociateDelegateFromResourceRequest(input *DisassociateDelegateFromResourceInput) (req *request.Request, output *DisassociateDelegateFromResourceOutput)

DisassociateDelegateFromResourceRequest generates a "aws/request.Request" representing the client's request for the DisassociateDelegateFromResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateDelegateFromResource for more information on using the DisassociateDelegateFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateDelegateFromResourceRequest method.
req, resp := client.DisassociateDelegateFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResource

func (*WorkMail) DisassociateDelegateFromResourceWithContext 

func (c *WorkMail) DisassociateDelegateFromResourceWithContext(ctx aws.Context, input *DisassociateDelegateFromResourceInput, opts ...request.Option) (*DisassociateDelegateFromResourceOutput, error)

DisassociateDelegateFromResourceWithContext is the same as DisassociateDelegateFromResource with the addition of the ability to pass a context and additional request options.

See DisassociateDelegateFromResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) DisassociateMemberFromGroup 

func (c *WorkMail) DisassociateMemberFromGroup(input *DisassociateMemberFromGroupInput) (*DisassociateMemberFromGroupOutput, error)

DisassociateMemberFromGroup API operation for Amazon WorkMail.

Removes a member from a group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation DisassociateMemberFromGroup for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroup

func (*WorkMail) DisassociateMemberFromGroupRequest 

func (c *WorkMail) DisassociateMemberFromGroupRequest(input *DisassociateMemberFromGroupInput) (req *request.Request, output *DisassociateMemberFromGroupOutput)

DisassociateMemberFromGroupRequest generates a "aws/request.Request" representing the client's request for the DisassociateMemberFromGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateMemberFromGroup for more information on using the DisassociateMemberFromGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateMemberFromGroupRequest method.
req, resp := client.DisassociateMemberFromGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroup

func (*WorkMail) DisassociateMemberFromGroupWithContext 

func (c *WorkMail) DisassociateMemberFromGroupWithContext(ctx aws.Context, input *DisassociateMemberFromGroupInput, opts ...request.Option) (*DisassociateMemberFromGroupOutput, error)

DisassociateMemberFromGroupWithContext is the same as DisassociateMemberFromGroup with the addition of the ability to pass a context and additional request options.

See DisassociateMemberFromGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) GetAccessControlEffect added in v1.29.1 

func (c *WorkMail) GetAccessControlEffect(input *GetAccessControlEffectInput) (*GetAccessControlEffectOutput, error)

GetAccessControlEffect API operation for Amazon WorkMail.

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation GetAccessControlEffect for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetAccessControlEffect

func (*WorkMail) GetAccessControlEffectRequest added in v1.29.1 

func (c *WorkMail) GetAccessControlEffectRequest(input *GetAccessControlEffectInput) (req *request.Request, output *GetAccessControlEffectOutput)

GetAccessControlEffectRequest generates a "aws/request.Request" representing the client's request for the GetAccessControlEffect operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccessControlEffect for more information on using the GetAccessControlEffect API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAccessControlEffectRequest method.
req, resp := client.GetAccessControlEffectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetAccessControlEffect

func (*WorkMail) GetAccessControlEffectWithContext added in v1.29.1 

func (c *WorkMail) GetAccessControlEffectWithContext(ctx aws.Context, input *GetAccessControlEffectInput, opts ...request.Option) (*GetAccessControlEffectOutput, error)

GetAccessControlEffectWithContext is the same as GetAccessControlEffect with the addition of the ability to pass a context and additional request options.

See GetAccessControlEffect for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) GetDefaultRetentionPolicy added in v1.31.7 

func (c *WorkMail) GetDefaultRetentionPolicy(input *GetDefaultRetentionPolicyInput) (*GetDefaultRetentionPolicyOutput, error)

GetDefaultRetentionPolicy API operation for Amazon WorkMail.

Gets the default retention policy details for the specified organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation GetDefaultRetentionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicy

func (*WorkMail) GetDefaultRetentionPolicyRequest added in v1.31.7 

func (c *WorkMail) GetDefaultRetentionPolicyRequest(input *GetDefaultRetentionPolicyInput) (req *request.Request, output *GetDefaultRetentionPolicyOutput)

GetDefaultRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the GetDefaultRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDefaultRetentionPolicy for more information on using the GetDefaultRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDefaultRetentionPolicyRequest method.
req, resp := client.GetDefaultRetentionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicy

func (*WorkMail) GetDefaultRetentionPolicyWithContext added in v1.31.7 

func (c *WorkMail) GetDefaultRetentionPolicyWithContext(ctx aws.Context, input *GetDefaultRetentionPolicyInput, opts ...request.Option) (*GetDefaultRetentionPolicyOutput, error)

GetDefaultRetentionPolicyWithContext is the same as GetDefaultRetentionPolicy with the addition of the ability to pass a context and additional request options.

See GetDefaultRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) GetMailboxDetails added in v1.19.24 

func (c *WorkMail) GetMailboxDetails(input *GetMailboxDetailsInput) (*GetMailboxDetailsOutput, error)

GetMailboxDetails API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation GetMailboxDetails for usage and error information.

Returned Error Types:

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetails

func (*WorkMail) GetMailboxDetailsRequest added in v1.19.24 

func (c *WorkMail) GetMailboxDetailsRequest(input *GetMailboxDetailsInput) (req *request.Request, output *GetMailboxDetailsOutput)

GetMailboxDetailsRequest generates a "aws/request.Request" representing the client's request for the GetMailboxDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMailboxDetails for more information on using the GetMailboxDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMailboxDetailsRequest method.
req, resp := client.GetMailboxDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetails

func (*WorkMail) GetMailboxDetailsWithContext added in v1.19.24 

func (c *WorkMail) GetMailboxDetailsWithContext(ctx aws.Context, input *GetMailboxDetailsInput, opts ...request.Option) (*GetMailboxDetailsOutput, error)

GetMailboxDetailsWithContext is the same as GetMailboxDetails with the addition of the ability to pass a context and additional request options.

See GetMailboxDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) GetMobileDeviceAccessEffect added in v1.38.10 

func (c *WorkMail) GetMobileDeviceAccessEffect(input *GetMobileDeviceAccessEffectInput) (*GetMobileDeviceAccessEffectOutput, error)

GetMobileDeviceAccessEffect API operation for Amazon WorkMail.

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation GetMobileDeviceAccessEffect for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessEffect

func (*WorkMail) GetMobileDeviceAccessEffectRequest added in v1.38.10 

func (c *WorkMail) GetMobileDeviceAccessEffectRequest(input *GetMobileDeviceAccessEffectInput) (req *request.Request, output *GetMobileDeviceAccessEffectOutput)

GetMobileDeviceAccessEffectRequest generates a "aws/request.Request" representing the client's request for the GetMobileDeviceAccessEffect operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMobileDeviceAccessEffect for more information on using the GetMobileDeviceAccessEffect API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMobileDeviceAccessEffectRequest method.
req, resp := client.GetMobileDeviceAccessEffectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessEffect

func (*WorkMail) GetMobileDeviceAccessEffectWithContext added in v1.38.10 

func (c *WorkMail) GetMobileDeviceAccessEffectWithContext(ctx aws.Context, input *GetMobileDeviceAccessEffectInput, opts ...request.Option) (*GetMobileDeviceAccessEffectOutput, error)

GetMobileDeviceAccessEffectWithContext is the same as GetMobileDeviceAccessEffect with the addition of the ability to pass a context and additional request options.

See GetMobileDeviceAccessEffect for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListAccessControlRules added in v1.29.1 

func (c *WorkMail) ListAccessControlRules(input *ListAccessControlRulesInput) (*ListAccessControlRulesOutput, error)

ListAccessControlRules API operation for Amazon WorkMail.

Lists the access control rules for the specified organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListAccessControlRules for usage and error information.

Returned Error Types:

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAccessControlRules

func (*WorkMail) ListAccessControlRulesRequest added in v1.29.1 

func (c *WorkMail) ListAccessControlRulesRequest(input *ListAccessControlRulesInput) (req *request.Request, output *ListAccessControlRulesOutput)

ListAccessControlRulesRequest generates a "aws/request.Request" representing the client's request for the ListAccessControlRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAccessControlRules for more information on using the ListAccessControlRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAccessControlRulesRequest method.
req, resp := client.ListAccessControlRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAccessControlRules

func (*WorkMail) ListAccessControlRulesWithContext added in v1.29.1 

func (c *WorkMail) ListAccessControlRulesWithContext(ctx aws.Context, input *ListAccessControlRulesInput, opts ...request.Option) (*ListAccessControlRulesOutput, error)

ListAccessControlRulesWithContext is the same as ListAccessControlRules with the addition of the ability to pass a context and additional request options.

See ListAccessControlRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListAliases 

func (c *WorkMail) ListAliases(input *ListAliasesInput) (*ListAliasesOutput, error)

ListAliases API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListAliases for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases

func (*WorkMail) ListAliasesPages 

func (c *WorkMail) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error

ListAliasesPages iterates over the pages of a ListAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAliases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAliases operation.
pageNum := 0
err := client.ListAliasesPages(params,
    func(page *workmail.ListAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListAliasesPagesWithContext 

func (c *WorkMail) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool, opts ...request.Option) error

ListAliasesPagesWithContext same as ListAliasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListAliasesRequest 

func (c *WorkMail) ListAliasesRequest(input *ListAliasesInput) (req *request.Request, output *ListAliasesOutput)

ListAliasesRequest generates a "aws/request.Request" representing the client's request for the ListAliases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAliases for more information on using the ListAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAliasesRequest method.
req, resp := client.ListAliasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases

func (*WorkMail) ListAliasesWithContext 

func (c *WorkMail) ListAliasesWithContext(ctx aws.Context, input *ListAliasesInput, opts ...request.Option) (*ListAliasesOutput, error)

ListAliasesWithContext is the same as ListAliases with the addition of the ability to pass a context and additional request options.

See ListAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListGroupMembers 

func (c *WorkMail) ListGroupMembers(input *ListGroupMembersInput) (*ListGroupMembersOutput, error)

ListGroupMembers API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListGroupMembers for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembers

func (*WorkMail) ListGroupMembersPages 

func (c *WorkMail) ListGroupMembersPages(input *ListGroupMembersInput, fn func(*ListGroupMembersOutput, bool) bool) error

ListGroupMembersPages iterates over the pages of a ListGroupMembers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroupMembers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGroupMembers operation.
pageNum := 0
err := client.ListGroupMembersPages(params,
    func(page *workmail.ListGroupMembersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListGroupMembersPagesWithContext 

func (c *WorkMail) ListGroupMembersPagesWithContext(ctx aws.Context, input *ListGroupMembersInput, fn func(*ListGroupMembersOutput, bool) bool, opts ...request.Option) error

ListGroupMembersPagesWithContext same as ListGroupMembersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListGroupMembersRequest 

func (c *WorkMail) ListGroupMembersRequest(input *ListGroupMembersInput) (req *request.Request, output *ListGroupMembersOutput)

ListGroupMembersRequest generates a "aws/request.Request" representing the client's request for the ListGroupMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroupMembers for more information on using the ListGroupMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGroupMembersRequest method.
req, resp := client.ListGroupMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembers

func (*WorkMail) ListGroupMembersWithContext 

func (c *WorkMail) ListGroupMembersWithContext(ctx aws.Context, input *ListGroupMembersInput, opts ...request.Option) (*ListGroupMembersOutput, error)

ListGroupMembersWithContext is the same as ListGroupMembers with the addition of the ability to pass a context and additional request options.

See ListGroupMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListGroups 

func (c *WorkMail) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for Amazon WorkMail.

Returns summaries of the organization's groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListGroups for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroups

func (*WorkMail) ListGroupsPages 

func (c *WorkMail) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error

ListGroupsPages iterates over the pages of a ListGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGroups operation.
pageNum := 0
err := client.ListGroupsPages(params,
    func(page *workmail.ListGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListGroupsPagesWithContext 

func (c *WorkMail) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error

ListGroupsPagesWithContext same as ListGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListGroupsRequest 

func (c *WorkMail) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)

ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroups for more information on using the ListGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroups

func (*WorkMail) ListGroupsWithContext 

func (c *WorkMail) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)

ListGroupsWithContext is the same as ListGroups with the addition of the ability to pass a context and additional request options.

See ListGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListMailboxExportJobs added in v1.34.29 

func (c *WorkMail) ListMailboxExportJobs(input *ListMailboxExportJobsInput) (*ListMailboxExportJobsOutput, error)

ListMailboxExportJobs API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListMailboxExportJobs for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobs

func (*WorkMail) ListMailboxExportJobsPages added in v1.34.29 

func (c *WorkMail) ListMailboxExportJobsPages(input *ListMailboxExportJobsInput, fn func(*ListMailboxExportJobsOutput, bool) bool) error

ListMailboxExportJobsPages iterates over the pages of a ListMailboxExportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMailboxExportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMailboxExportJobs operation.
pageNum := 0
err := client.ListMailboxExportJobsPages(params,
    func(page *workmail.ListMailboxExportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListMailboxExportJobsPagesWithContext added in v1.34.29 

func (c *WorkMail) ListMailboxExportJobsPagesWithContext(ctx aws.Context, input *ListMailboxExportJobsInput, fn func(*ListMailboxExportJobsOutput, bool) bool, opts ...request.Option) error

ListMailboxExportJobsPagesWithContext same as ListMailboxExportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListMailboxExportJobsRequest added in v1.34.29 

func (c *WorkMail) ListMailboxExportJobsRequest(input *ListMailboxExportJobsInput) (req *request.Request, output *ListMailboxExportJobsOutput)

ListMailboxExportJobsRequest generates a "aws/request.Request" representing the client's request for the ListMailboxExportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMailboxExportJobs for more information on using the ListMailboxExportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMailboxExportJobsRequest method.
req, resp := client.ListMailboxExportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobs

func (*WorkMail) ListMailboxExportJobsWithContext added in v1.34.29 

func (c *WorkMail) ListMailboxExportJobsWithContext(ctx aws.Context, input *ListMailboxExportJobsInput, opts ...request.Option) (*ListMailboxExportJobsOutput, error)

ListMailboxExportJobsWithContext is the same as ListMailboxExportJobs with the addition of the ability to pass a context and additional request options.

See ListMailboxExportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListMailboxPermissions added in v1.13.32 

func (c *WorkMail) ListMailboxPermissions(input *ListMailboxPermissionsInput) (*ListMailboxPermissionsOutput, error)

ListMailboxPermissions API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListMailboxPermissions for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissions

func (*WorkMail) ListMailboxPermissionsPages added in v1.13.32 

func (c *WorkMail) ListMailboxPermissionsPages(input *ListMailboxPermissionsInput, fn func(*ListMailboxPermissionsOutput, bool) bool) error

ListMailboxPermissionsPages iterates over the pages of a ListMailboxPermissions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMailboxPermissions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMailboxPermissions operation.
pageNum := 0
err := client.ListMailboxPermissionsPages(params,
    func(page *workmail.ListMailboxPermissionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListMailboxPermissionsPagesWithContext added in v1.13.32 

func (c *WorkMail) ListMailboxPermissionsPagesWithContext(ctx aws.Context, input *ListMailboxPermissionsInput, fn func(*ListMailboxPermissionsOutput, bool) bool, opts ...request.Option) error

ListMailboxPermissionsPagesWithContext same as ListMailboxPermissionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListMailboxPermissionsRequest added in v1.13.32 

func (c *WorkMail) ListMailboxPermissionsRequest(input *ListMailboxPermissionsInput) (req *request.Request, output *ListMailboxPermissionsOutput)

ListMailboxPermissionsRequest generates a "aws/request.Request" representing the client's request for the ListMailboxPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMailboxPermissions for more information on using the ListMailboxPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMailboxPermissionsRequest method.
req, resp := client.ListMailboxPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissions

func (*WorkMail) ListMailboxPermissionsWithContext added in v1.13.32 

func (c *WorkMail) ListMailboxPermissionsWithContext(ctx aws.Context, input *ListMailboxPermissionsInput, opts ...request.Option) (*ListMailboxPermissionsOutput, error)

ListMailboxPermissionsWithContext is the same as ListMailboxPermissions with the addition of the ability to pass a context and additional request options.

See ListMailboxPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListMobileDeviceAccessRules added in v1.38.10 

func (c *WorkMail) ListMobileDeviceAccessRules(input *ListMobileDeviceAccessRulesInput) (*ListMobileDeviceAccessRulesOutput, error)

ListMobileDeviceAccessRules API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListMobileDeviceAccessRules for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessRules

func (*WorkMail) ListMobileDeviceAccessRulesRequest added in v1.38.10 

func (c *WorkMail) ListMobileDeviceAccessRulesRequest(input *ListMobileDeviceAccessRulesInput) (req *request.Request, output *ListMobileDeviceAccessRulesOutput)

ListMobileDeviceAccessRulesRequest generates a "aws/request.Request" representing the client's request for the ListMobileDeviceAccessRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMobileDeviceAccessRules for more information on using the ListMobileDeviceAccessRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMobileDeviceAccessRulesRequest method.
req, resp := client.ListMobileDeviceAccessRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessRules

func (*WorkMail) ListMobileDeviceAccessRulesWithContext added in v1.38.10 

func (c *WorkMail) ListMobileDeviceAccessRulesWithContext(ctx aws.Context, input *ListMobileDeviceAccessRulesInput, opts ...request.Option) (*ListMobileDeviceAccessRulesOutput, error)

ListMobileDeviceAccessRulesWithContext is the same as ListMobileDeviceAccessRules with the addition of the ability to pass a context and additional request options.

See ListMobileDeviceAccessRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListOrganizations 

func (c *WorkMail) ListOrganizations(input *ListOrganizationsInput) (*ListOrganizationsOutput, error)

ListOrganizations API operation for Amazon WorkMail.

Returns summaries of the customer's organizations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListOrganizations for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations

func (*WorkMail) ListOrganizationsPages 

func (c *WorkMail) ListOrganizationsPages(input *ListOrganizationsInput, fn func(*ListOrganizationsOutput, bool) bool) error

ListOrganizationsPages iterates over the pages of a ListOrganizations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOrganizations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListOrganizations operation.
pageNum := 0
err := client.ListOrganizationsPages(params,
    func(page *workmail.ListOrganizationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListOrganizationsPagesWithContext 

func (c *WorkMail) ListOrganizationsPagesWithContext(ctx aws.Context, input *ListOrganizationsInput, fn func(*ListOrganizationsOutput, bool) bool, opts ...request.Option) error

ListOrganizationsPagesWithContext same as ListOrganizationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListOrganizationsRequest 

func (c *WorkMail) ListOrganizationsRequest(input *ListOrganizationsInput) (req *request.Request, output *ListOrganizationsOutput)

ListOrganizationsRequest generates a "aws/request.Request" representing the client's request for the ListOrganizations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOrganizations for more information on using the ListOrganizations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListOrganizationsRequest method.
req, resp := client.ListOrganizationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations

func (*WorkMail) ListOrganizationsWithContext 

func (c *WorkMail) ListOrganizationsWithContext(ctx aws.Context, input *ListOrganizationsInput, opts ...request.Option) (*ListOrganizationsOutput, error)

ListOrganizationsWithContext is the same as ListOrganizations with the addition of the ability to pass a context and additional request options.

See ListOrganizations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListResourceDelegates 

func (c *WorkMail) ListResourceDelegates(input *ListResourceDelegatesInput) (*ListResourceDelegatesOutput, error)

ListResourceDelegates API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListResourceDelegates for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegates

func (*WorkMail) ListResourceDelegatesPages added in v1.19.24 

func (c *WorkMail) ListResourceDelegatesPages(input *ListResourceDelegatesInput, fn func(*ListResourceDelegatesOutput, bool) bool) error

ListResourceDelegatesPages iterates over the pages of a ListResourceDelegates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListResourceDelegates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListResourceDelegates operation.
pageNum := 0
err := client.ListResourceDelegatesPages(params,
    func(page *workmail.ListResourceDelegatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListResourceDelegatesPagesWithContext added in v1.19.24 

func (c *WorkMail) ListResourceDelegatesPagesWithContext(ctx aws.Context, input *ListResourceDelegatesInput, fn func(*ListResourceDelegatesOutput, bool) bool, opts ...request.Option) error

ListResourceDelegatesPagesWithContext same as ListResourceDelegatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListResourceDelegatesRequest 

func (c *WorkMail) ListResourceDelegatesRequest(input *ListResourceDelegatesInput) (req *request.Request, output *ListResourceDelegatesOutput)

ListResourceDelegatesRequest generates a "aws/request.Request" representing the client's request for the ListResourceDelegates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResourceDelegates for more information on using the ListResourceDelegates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListResourceDelegatesRequest method.
req, resp := client.ListResourceDelegatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegates

func (*WorkMail) ListResourceDelegatesWithContext 

func (c *WorkMail) ListResourceDelegatesWithContext(ctx aws.Context, input *ListResourceDelegatesInput, opts ...request.Option) (*ListResourceDelegatesOutput, error)

ListResourceDelegatesWithContext is the same as ListResourceDelegates with the addition of the ability to pass a context and additional request options.

See ListResourceDelegates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListResources 

func (c *WorkMail) ListResources(input *ListResourcesInput) (*ListResourcesOutput, error)

ListResources API operation for Amazon WorkMail.

Returns summaries of the organization's resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListResources for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResources

func (*WorkMail) ListResourcesPages 

func (c *WorkMail) ListResourcesPages(input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool) error

ListResourcesPages iterates over the pages of a ListResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListResources operation.
pageNum := 0
err := client.ListResourcesPages(params,
    func(page *workmail.ListResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListResourcesPagesWithContext 

func (c *WorkMail) ListResourcesPagesWithContext(ctx aws.Context, input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool, opts ...request.Option) error

ListResourcesPagesWithContext same as ListResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListResourcesRequest 

func (c *WorkMail) ListResourcesRequest(input *ListResourcesInput) (req *request.Request, output *ListResourcesOutput)

ListResourcesRequest generates a "aws/request.Request" representing the client's request for the ListResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResources for more information on using the ListResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListResourcesRequest method.
req, resp := client.ListResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResources

func (*WorkMail) ListResourcesWithContext 

func (c *WorkMail) ListResourcesWithContext(ctx aws.Context, input *ListResourcesInput, opts ...request.Option) (*ListResourcesOutput, error)

ListResourcesWithContext is the same as ListResources with the addition of the ability to pass a context and additional request options.

See ListResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListTagsForResource added in v1.28.10 

func (c *WorkMail) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon WorkMail.

Lists the tags applied to an Amazon WorkMail organization resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource cannot be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListTagsForResource

func (*WorkMail) ListTagsForResourceRequest added in v1.28.10 

func (c *WorkMail) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListTagsForResource

func (*WorkMail) ListTagsForResourceWithContext added in v1.28.10 

func (c *WorkMail) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListUsers 

func (c *WorkMail) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for Amazon WorkMail.

Returns summaries of the organization's users.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ListUsers for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsers

func (*WorkMail) ListUsersPages 

func (c *WorkMail) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error

ListUsersPages iterates over the pages of a ListUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListUsers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListUsers operation.
pageNum := 0
err := client.ListUsersPages(params,
    func(page *workmail.ListUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkMail) ListUsersPagesWithContext 

func (c *WorkMail) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error

ListUsersPagesWithContext same as ListUsersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ListUsersRequest 

func (c *WorkMail) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUsers for more information on using the ListUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsers

func (*WorkMail) ListUsersWithContext 

func (c *WorkMail) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) PutAccessControlRule added in v1.29.1 

func (c *WorkMail) PutAccessControlRule(input *PutAccessControlRuleInput) (*PutAccessControlRuleOutput, error)

PutAccessControlRule API operation for Amazon WorkMail.

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation PutAccessControlRule for usage and error information.

Returned Error Types:

  • LimitExceededException The request exceeds the limit of the resource.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutAccessControlRule

func (*WorkMail) PutAccessControlRuleRequest added in v1.29.1 

func (c *WorkMail) PutAccessControlRuleRequest(input *PutAccessControlRuleInput) (req *request.Request, output *PutAccessControlRuleOutput)

PutAccessControlRuleRequest generates a "aws/request.Request" representing the client's request for the PutAccessControlRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAccessControlRule for more information on using the PutAccessControlRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutAccessControlRuleRequest method.
req, resp := client.PutAccessControlRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutAccessControlRule

func (*WorkMail) PutAccessControlRuleWithContext added in v1.29.1 

func (c *WorkMail) PutAccessControlRuleWithContext(ctx aws.Context, input *PutAccessControlRuleInput, opts ...request.Option) (*PutAccessControlRuleOutput, error)

PutAccessControlRuleWithContext is the same as PutAccessControlRule with the addition of the ability to pass a context and additional request options.

See PutAccessControlRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) PutMailboxPermissions added in v1.13.32 

func (c *WorkMail) PutMailboxPermissions(input *PutMailboxPermissionsInput) (*PutMailboxPermissionsOutput, error)

PutMailboxPermissions API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation PutMailboxPermissions for usage and error information.

Returned Error Types:

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissions

func (*WorkMail) PutMailboxPermissionsRequest added in v1.13.32 

func (c *WorkMail) PutMailboxPermissionsRequest(input *PutMailboxPermissionsInput) (req *request.Request, output *PutMailboxPermissionsOutput)

PutMailboxPermissionsRequest generates a "aws/request.Request" representing the client's request for the PutMailboxPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutMailboxPermissions for more information on using the PutMailboxPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutMailboxPermissionsRequest method.
req, resp := client.PutMailboxPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissions

func (*WorkMail) PutMailboxPermissionsWithContext added in v1.13.32 

func (c *WorkMail) PutMailboxPermissionsWithContext(ctx aws.Context, input *PutMailboxPermissionsInput, opts ...request.Option) (*PutMailboxPermissionsOutput, error)

PutMailboxPermissionsWithContext is the same as PutMailboxPermissions with the addition of the ability to pass a context and additional request options.

See PutMailboxPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) PutRetentionPolicy added in v1.31.7 

func (c *WorkMail) PutRetentionPolicy(input *PutRetentionPolicyInput) (*PutRetentionPolicyOutput, error)

PutRetentionPolicy API operation for Amazon WorkMail.

Puts a retention policy to the specified organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation PutRetentionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • LimitExceededException The request exceeds the limit of the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicy

func (*WorkMail) PutRetentionPolicyRequest added in v1.31.7 

func (c *WorkMail) PutRetentionPolicyRequest(input *PutRetentionPolicyInput) (req *request.Request, output *PutRetentionPolicyOutput)

PutRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the PutRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRetentionPolicy for more information on using the PutRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutRetentionPolicyRequest method.
req, resp := client.PutRetentionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicy

func (*WorkMail) PutRetentionPolicyWithContext added in v1.31.7 

func (c *WorkMail) PutRetentionPolicyWithContext(ctx aws.Context, input *PutRetentionPolicyInput, opts ...request.Option) (*PutRetentionPolicyOutput, error)

PutRetentionPolicyWithContext is the same as PutRetentionPolicy with the addition of the ability to pass a context and additional request options.

See PutRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) RegisterToWorkMail 

func (c *WorkMail) RegisterToWorkMail(input *RegisterToWorkMailInput) (*RegisterToWorkMailOutput, error)

RegisterToWorkMail API operation for Amazon WorkMail.

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing (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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation RegisterToWorkMail for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is already registered.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • MailDomainNotFoundException For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

  • MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail

func (*WorkMail) RegisterToWorkMailRequest 

func (c *WorkMail) RegisterToWorkMailRequest(input *RegisterToWorkMailInput) (req *request.Request, output *RegisterToWorkMailOutput)

RegisterToWorkMailRequest generates a "aws/request.Request" representing the client's request for the RegisterToWorkMail operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterToWorkMail for more information on using the RegisterToWorkMail API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterToWorkMailRequest method.
req, resp := client.RegisterToWorkMailRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail

func (*WorkMail) RegisterToWorkMailWithContext 

func (c *WorkMail) RegisterToWorkMailWithContext(ctx aws.Context, input *RegisterToWorkMailInput, opts ...request.Option) (*RegisterToWorkMailOutput, error)

RegisterToWorkMailWithContext is the same as RegisterToWorkMail with the addition of the ability to pass a context and additional request options.

See RegisterToWorkMail for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) ResetPassword 

func (c *WorkMail) ResetPassword(input *ResetPasswordInput) (*ResetPasswordOutput, error)

ResetPassword API operation for Amazon WorkMail.

Allows the administrator to reset the password for a user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation ResetPassword for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • InvalidPasswordException The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPassword

func (*WorkMail) ResetPasswordRequest 

func (c *WorkMail) ResetPasswordRequest(input *ResetPasswordInput) (req *request.Request, output *ResetPasswordOutput)

ResetPasswordRequest generates a "aws/request.Request" representing the client's request for the ResetPassword operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetPassword for more information on using the ResetPassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ResetPasswordRequest method.
req, resp := client.ResetPasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPassword

func (*WorkMail) ResetPasswordWithContext 

func (c *WorkMail) ResetPasswordWithContext(ctx aws.Context, input *ResetPasswordInput, opts ...request.Option) (*ResetPasswordOutput, error)

ResetPasswordWithContext is the same as ResetPassword with the addition of the ability to pass a context and additional request options.

See ResetPassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) StartMailboxExportJob added in v1.34.29 

func (c *WorkMail) StartMailboxExportJob(input *StartMailboxExportJobInput) (*StartMailboxExportJobOutput, error)

StartMailboxExportJob API operation for Amazon WorkMail.

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 Amazon WorkMail Administrator Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation StartMailboxExportJob for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • LimitExceededException The request exceeds the limit of the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJob

func (*WorkMail) StartMailboxExportJobRequest added in v1.34.29 

func (c *WorkMail) StartMailboxExportJobRequest(input *StartMailboxExportJobInput) (req *request.Request, output *StartMailboxExportJobOutput)

StartMailboxExportJobRequest generates a "aws/request.Request" representing the client's request for the StartMailboxExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartMailboxExportJob for more information on using the StartMailboxExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartMailboxExportJobRequest method.
req, resp := client.StartMailboxExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJob

func (*WorkMail) StartMailboxExportJobWithContext added in v1.34.29 

func (c *WorkMail) StartMailboxExportJobWithContext(ctx aws.Context, input *StartMailboxExportJobInput, opts ...request.Option) (*StartMailboxExportJobOutput, error)

StartMailboxExportJobWithContext is the same as StartMailboxExportJob with the addition of the ability to pass a context and additional request options.

See StartMailboxExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) TagResource added in v1.28.10 

func (c *WorkMail) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon WorkMail.

Applies the specified tags to the specified Amazon WorkMail organization resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource cannot be found.

  • TooManyTagsException The resource can have up to 50 user-applied tags.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/TagResource

func (*WorkMail) TagResourceRequest added in v1.28.10 

func (c *WorkMail) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/TagResource

func (*WorkMail) TagResourceWithContext added in v1.28.10 

func (c *WorkMail) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) UntagResource added in v1.28.10 

func (c *WorkMail) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon WorkMail.

Untags the specified tags from the specified Amazon WorkMail organization resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource cannot be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UntagResource

func (*WorkMail) UntagResourceRequest added in v1.28.10 

func (c *WorkMail) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UntagResource

func (*WorkMail) UntagResourceWithContext added in v1.28.10 

func (c *WorkMail) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) UpdateMailboxQuota added in v1.19.24 

func (c *WorkMail) UpdateMailboxQuota(input *UpdateMailboxQuotaInput) (*UpdateMailboxQuotaOutput, error)

UpdateMailboxQuota API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation UpdateMailboxQuota for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuota

func (*WorkMail) UpdateMailboxQuotaRequest added in v1.19.24 

func (c *WorkMail) UpdateMailboxQuotaRequest(input *UpdateMailboxQuotaInput) (req *request.Request, output *UpdateMailboxQuotaOutput)

UpdateMailboxQuotaRequest generates a "aws/request.Request" representing the client's request for the UpdateMailboxQuota operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMailboxQuota for more information on using the UpdateMailboxQuota API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateMailboxQuotaRequest method.
req, resp := client.UpdateMailboxQuotaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuota

func (*WorkMail) UpdateMailboxQuotaWithContext added in v1.19.24 

func (c *WorkMail) UpdateMailboxQuotaWithContext(ctx aws.Context, input *UpdateMailboxQuotaInput, opts ...request.Option) (*UpdateMailboxQuotaOutput, error)

UpdateMailboxQuotaWithContext is the same as UpdateMailboxQuota with the addition of the ability to pass a context and additional request options.

See UpdateMailboxQuota for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) UpdateMobileDeviceAccessRule added in v1.38.10 

func (c *WorkMail) UpdateMobileDeviceAccessRule(input *UpdateMobileDeviceAccessRuleInput) (*UpdateMobileDeviceAccessRuleOutput, error)

UpdateMobileDeviceAccessRule API operation for Amazon WorkMail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation UpdateMobileDeviceAccessRule for usage and error information.

Returned Error Types:

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMobileDeviceAccessRule

func (*WorkMail) UpdateMobileDeviceAccessRuleRequest added in v1.38.10 

func (c *WorkMail) UpdateMobileDeviceAccessRuleRequest(input *UpdateMobileDeviceAccessRuleInput) (req *request.Request, output *UpdateMobileDeviceAccessRuleOutput)

UpdateMobileDeviceAccessRuleRequest generates a "aws/request.Request" representing the client's request for the UpdateMobileDeviceAccessRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMobileDeviceAccessRule for more information on using the UpdateMobileDeviceAccessRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateMobileDeviceAccessRuleRequest method.
req, resp := client.UpdateMobileDeviceAccessRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMobileDeviceAccessRule

func (*WorkMail) UpdateMobileDeviceAccessRuleWithContext added in v1.38.10 

func (c *WorkMail) UpdateMobileDeviceAccessRuleWithContext(ctx aws.Context, input *UpdateMobileDeviceAccessRuleInput, opts ...request.Option) (*UpdateMobileDeviceAccessRuleOutput, error)

UpdateMobileDeviceAccessRuleWithContext is the same as UpdateMobileDeviceAccessRule with the addition of the ability to pass a context and additional request options.

See UpdateMobileDeviceAccessRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) UpdatePrimaryEmailAddress 

func (c *WorkMail) UpdatePrimaryEmailAddress(input *UpdatePrimaryEmailAddressInput) (*UpdatePrimaryEmailAddressOutput, error)

UpdatePrimaryEmailAddress API operation for Amazon WorkMail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation UpdatePrimaryEmailAddress for usage and error information.

Returned Error Types:

  • DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • MailDomainNotFoundException For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

  • MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.

  • InvalidParameterException One or more of the input parameters don't match the service's restrictions.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

  • UnsupportedOperationException You can't perform a write operation against a read-only directory.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddress

func (*WorkMail) UpdatePrimaryEmailAddressRequest 

func (c *WorkMail) UpdatePrimaryEmailAddressRequest(input *UpdatePrimaryEmailAddressInput) (req *request.Request, output *UpdatePrimaryEmailAddressOutput)

UpdatePrimaryEmailAddressRequest generates a "aws/request.Request" representing the client's request for the UpdatePrimaryEmailAddress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePrimaryEmailAddress for more information on using the UpdatePrimaryEmailAddress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdatePrimaryEmailAddressRequest method.
req, resp := client.UpdatePrimaryEmailAddressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddress

func (*WorkMail) UpdatePrimaryEmailAddressWithContext 

func (c *WorkMail) UpdatePrimaryEmailAddressWithContext(ctx aws.Context, input *UpdatePrimaryEmailAddressInput, opts ...request.Option) (*UpdatePrimaryEmailAddressOutput, error)

UpdatePrimaryEmailAddressWithContext is the same as UpdatePrimaryEmailAddress with the addition of the ability to pass a context and additional request options.

See UpdatePrimaryEmailAddress for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkMail) UpdateResource 

func (c *WorkMail) UpdateResource(input *UpdateResourceInput) (*UpdateResourceOutput, error)

UpdateResource API operation for Amazon WorkMail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail's API operation UpdateResource for usage and error information.

Returned Error Types:

  • DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.

  • EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.

  • EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

  • InvalidConfigurationException The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

  • EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.

  • MailDomainNotFoundException For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

  • MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.

  • NameAvailabilityException The user, group, or resource name isn't unique in Amazon WorkMail.

  • OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.

  • OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResource

func (*WorkMail) UpdateResourceRequest 

func (c *WorkMail) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *UpdateResourceOutput)

UpdateResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateResource for more information on using the UpdateResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateResourceRequest method.
req, resp := client.UpdateResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResource

func (*WorkMail) UpdateResourceWithContext 

func (c *WorkMail) UpdateResourceWithContext(ctx aws.Context, input *UpdateResourceInput, opts ...request.Option) (*UpdateResourceOutput, error)

UpdateResourceWithContext is the same as UpdateResource with the addition of the ability to pass a context and additional request options.

See UpdateResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Source Files

View all Source files

Directories

Path Synopsis
Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.
 Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.

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.