types

package
v1.1.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControlRule added in v0.29.0

type AccessControlRule struct {

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

	// The date that the rule was created.
	DateCreated *time.Time

	// The date that the rule was modified.
	DateModified *time.Time

	// The rule description.
	Description *string

	// The rule effect.
	Effect AccessControlRuleEffect

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

	// The rule name.
	Name *string

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

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

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

	// User IDs to include in the rule.
	UserIds []string
}

A rule that controls access to an Amazon WorkMail organization.

type AccessControlRuleEffect added in v0.29.0

type AccessControlRuleEffect string
const (
	AccessControlRuleEffectAllow AccessControlRuleEffect = "ALLOW"
	AccessControlRuleEffectDeny  AccessControlRuleEffect = "DENY"
)

Enum values for AccessControlRuleEffect

func (AccessControlRuleEffect) Values added in v0.29.0

Values returns all known values for AccessControlRuleEffect. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// The resource's ability to automatically decline any conflicting requests.
	AutoDeclineConflictingRequests bool

	// The resource's ability to automatically decline any recurring requests.
	AutoDeclineRecurringRequests bool
}

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

type Delegate

type Delegate struct {

	// The identifier for the user or group associated as the resource's delegate.
	//
	// This member is required.
	Id *string

	// The type of the delegate: user or group.
	//
	// This member is required.
	Type MemberType
}

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

type DirectoryInUseException added in v0.29.0

type DirectoryInUseException struct {
	Message *string
}

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

func (*DirectoryInUseException) Error added in v0.29.0

func (e *DirectoryInUseException) Error() string

func (*DirectoryInUseException) ErrorCode added in v0.29.0

func (e *DirectoryInUseException) ErrorCode() string

func (*DirectoryInUseException) ErrorFault added in v0.29.0

func (e *DirectoryInUseException) ErrorFault() smithy.ErrorFault

func (*DirectoryInUseException) ErrorMessage added in v0.29.0

func (e *DirectoryInUseException) ErrorMessage() string

type DirectoryServiceAuthenticationFailedException

type DirectoryServiceAuthenticationFailedException struct {
	Message *string
}

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

func (*DirectoryServiceAuthenticationFailedException) Error

func (*DirectoryServiceAuthenticationFailedException) ErrorCode

func (*DirectoryServiceAuthenticationFailedException) ErrorFault

func (*DirectoryServiceAuthenticationFailedException) ErrorMessage

type DirectoryUnavailableException

type DirectoryUnavailableException struct {
	Message *string
}

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

func (*DirectoryUnavailableException) Error

func (*DirectoryUnavailableException) ErrorCode

func (e *DirectoryUnavailableException) ErrorCode() string

func (*DirectoryUnavailableException) ErrorFault

func (*DirectoryUnavailableException) ErrorMessage

func (e *DirectoryUnavailableException) ErrorMessage() string

type Domain added in v0.29.0

type Domain struct {

	// The fully qualified domain name.
	DomainName *string

	// The hosted zone ID for a domain hosted in Route 53. Required when configuring a
	// domain hosted in Route 53.
	HostedZoneId *string
}

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.

type EmailAddressInUseException

type EmailAddressInUseException struct {
	Message *string
}

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

func (*EmailAddressInUseException) Error

func (*EmailAddressInUseException) ErrorCode

func (e *EmailAddressInUseException) ErrorCode() string

func (*EmailAddressInUseException) ErrorFault

func (*EmailAddressInUseException) ErrorMessage

func (e *EmailAddressInUseException) ErrorMessage() string

type EntityAlreadyRegisteredException

type EntityAlreadyRegisteredException struct {
	Message *string
}

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

func (*EntityAlreadyRegisteredException) Error

func (*EntityAlreadyRegisteredException) ErrorCode

func (*EntityAlreadyRegisteredException) ErrorFault

func (*EntityAlreadyRegisteredException) ErrorMessage

func (e *EntityAlreadyRegisteredException) ErrorMessage() string

type EntityNotFoundException

type EntityNotFoundException struct {
	Message *string
}

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

func (*EntityNotFoundException) Error

func (e *EntityNotFoundException) Error() string

func (*EntityNotFoundException) ErrorCode

func (e *EntityNotFoundException) ErrorCode() string

func (*EntityNotFoundException) ErrorFault

func (e *EntityNotFoundException) ErrorFault() smithy.ErrorFault

func (*EntityNotFoundException) ErrorMessage

func (e *EntityNotFoundException) ErrorMessage() string

type EntityState

type EntityState string
const (
	EntityStateEnabled  EntityState = "ENABLED"
	EntityStateDisabled EntityState = "DISABLED"
	EntityStateDeleted  EntityState = "DELETED"
)

Enum values for EntityState

func (EntityState) Values added in v0.29.0

func (EntityState) Values() []EntityState

Values returns all known values for EntityState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntityStateException

type EntityStateException struct {
	Message *string
}

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) Error

func (e *EntityStateException) Error() string

func (*EntityStateException) ErrorCode

func (e *EntityStateException) ErrorCode() string

func (*EntityStateException) ErrorFault

func (e *EntityStateException) ErrorFault() smithy.ErrorFault

func (*EntityStateException) ErrorMessage

func (e *EntityStateException) ErrorMessage() string

type FolderConfiguration added in v0.29.0

type FolderConfiguration struct {

	// The action to take on the folder contents at the end of the folder configuration
	// period.
	//
	// This member is required.
	Action RetentionAction

	// The folder name.
	//
	// This member is required.
	Name FolderName

	// The period of time at which the folder configuration action is applied.
	Period *int32
}

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

type FolderName added in v0.29.0

type FolderName string
const (
	FolderNameInbox        FolderName = "INBOX"
	FolderNameDeletedItems FolderName = "DELETED_ITEMS"
	FolderNameSentItems    FolderName = "SENT_ITEMS"
	FolderNameDrafts       FolderName = "DRAFTS"
	FolderNameJunkEmail    FolderName = "JUNK_EMAIL"
)

Enum values for FolderName

func (FolderName) Values added in v0.29.0

func (FolderName) Values() []FolderName

Values returns all known values for FolderName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Group

type Group struct {

	// The date indicating when the group was disabled from Amazon WorkMail use.
	DisabledDate *time.Time

	// The email of the group.
	Email *string

	// The date indicating when the group was enabled for Amazon WorkMail use.
	EnabledDate *time.Time

	// The identifier of the group.
	Id *string

	// The name of the group.
	Name *string

	// The state of the group, which can be ENABLED, DISABLED, or DELETED.
	State EntityState
}

The representation of an Amazon WorkMail group.

type InvalidConfigurationException

type InvalidConfigurationException struct {
	Message *string
}

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) Error

func (*InvalidConfigurationException) ErrorCode

func (e *InvalidConfigurationException) ErrorCode() string

func (*InvalidConfigurationException) ErrorFault

func (*InvalidConfigurationException) ErrorMessage

func (e *InvalidConfigurationException) ErrorMessage() string

type InvalidParameterException

type InvalidParameterException struct {
	Message *string
}

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

func (*InvalidParameterException) Error

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault

func (*InvalidParameterException) ErrorMessage

func (e *InvalidParameterException) ErrorMessage() string

type InvalidPasswordException

type InvalidPasswordException struct {
	Message *string
}

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

func (*InvalidPasswordException) Error

func (e *InvalidPasswordException) Error() string

func (*InvalidPasswordException) ErrorCode

func (e *InvalidPasswordException) ErrorCode() string

func (*InvalidPasswordException) ErrorFault

func (e *InvalidPasswordException) ErrorFault() smithy.ErrorFault

func (*InvalidPasswordException) ErrorMessage

func (e *InvalidPasswordException) ErrorMessage() string

type LimitExceededException added in v0.29.0

type LimitExceededException struct {
	Message *string
}

The request exceeds the limit of the resource.

func (*LimitExceededException) Error added in v0.29.0

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode added in v0.29.0

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault added in v0.29.0

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage added in v0.29.0

func (e *LimitExceededException) ErrorMessage() string

type MailDomainNotFoundException

type MailDomainNotFoundException struct {
	Message *string
}

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

func (*MailDomainNotFoundException) Error

func (*MailDomainNotFoundException) ErrorCode

func (e *MailDomainNotFoundException) ErrorCode() string

func (*MailDomainNotFoundException) ErrorFault

func (*MailDomainNotFoundException) ErrorMessage

func (e *MailDomainNotFoundException) ErrorMessage() string

type MailDomainStateException

type MailDomainStateException struct {
	Message *string
}

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

func (*MailDomainStateException) Error

func (e *MailDomainStateException) Error() string

func (*MailDomainStateException) ErrorCode

func (e *MailDomainStateException) ErrorCode() string

func (*MailDomainStateException) ErrorFault

func (e *MailDomainStateException) ErrorFault() smithy.ErrorFault

func (*MailDomainStateException) ErrorMessage

func (e *MailDomainStateException) ErrorMessage() string

type MailboxExportJob added in v0.29.0

type MailboxExportJob struct {

	// The mailbox export job description.
	Description *string

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

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

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

	// The identifier of the mailbox export job.
	JobId *string

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

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

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

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

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.

type MailboxExportJobState added in v0.29.0

type MailboxExportJobState string
const (
	MailboxExportJobStateRunning   MailboxExportJobState = "RUNNING"
	MailboxExportJobStateCompleted MailboxExportJobState = "COMPLETED"
	MailboxExportJobStateFailed    MailboxExportJobState = "FAILED"
	MailboxExportJobStateCancelled MailboxExportJobState = "CANCELLED"
)

Enum values for MailboxExportJobState

func (MailboxExportJobState) Values added in v0.29.0

Values returns all known values for MailboxExportJobState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Member

type Member struct {

	// The date indicating when the member was disabled from Amazon WorkMail use.
	DisabledDate *time.Time

	// The date indicating when the member was enabled for Amazon WorkMail use.
	EnabledDate *time.Time

	// The identifier of the member.
	Id *string

	// The name of the member.
	Name *string

	// The state of the member, which can be ENABLED, DISABLED, or DELETED.
	State EntityState

	// A member can be a user or group.
	Type MemberType
}

The representation of a user or group.

type MemberType

type MemberType string
const (
	MemberTypeGroup MemberType = "GROUP"
	MemberTypeUser  MemberType = "USER"
)

Enum values for MemberType

func (MemberType) Values added in v0.29.0

func (MemberType) Values() []MemberType

Values returns all known values for MemberType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NameAvailabilityException

type NameAvailabilityException struct {
	Message *string
}

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

func (*NameAvailabilityException) Error

func (e *NameAvailabilityException) Error() string

func (*NameAvailabilityException) ErrorCode

func (e *NameAvailabilityException) ErrorCode() string

func (*NameAvailabilityException) ErrorFault

func (*NameAvailabilityException) ErrorMessage

func (e *NameAvailabilityException) ErrorMessage() string

type OrganizationNotFoundException

type OrganizationNotFoundException struct {
	Message *string
}

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

func (*OrganizationNotFoundException) Error

func (*OrganizationNotFoundException) ErrorCode

func (e *OrganizationNotFoundException) ErrorCode() string

func (*OrganizationNotFoundException) ErrorFault

func (*OrganizationNotFoundException) ErrorMessage

func (e *OrganizationNotFoundException) ErrorMessage() string

type OrganizationStateException

type OrganizationStateException struct {
	Message *string
}

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

func (*OrganizationStateException) Error

func (*OrganizationStateException) ErrorCode

func (e *OrganizationStateException) ErrorCode() string

func (*OrganizationStateException) ErrorFault

func (*OrganizationStateException) ErrorMessage

func (e *OrganizationStateException) ErrorMessage() string

type OrganizationSummary

type OrganizationSummary struct {

	// The alias associated with the organization.
	Alias *string

	// The default email domain associated with the organization.
	DefaultMailDomain *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

	// The identifier associated with the organization.
	OrganizationId *string

	// The state associated with the organization.
	State *string
}

The representation of an organization.

type Permission

type Permission struct {

	// The identifier of the user, group, or resource to which the permissions are
	// granted.
	//
	// This member is required.
	GranteeId *string

	// The type of user, group, or resource referred to in GranteeId.
	//
	// This member is required.
	GranteeType 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.
	//
	// This member is required.
	PermissionValues []PermissionType
}

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

type PermissionType

type PermissionType string
const (
	PermissionTypeFullAccess   PermissionType = "FULL_ACCESS"
	PermissionTypeSendAs       PermissionType = "SEND_AS"
	PermissionTypeSendOnBehalf PermissionType = "SEND_ON_BEHALF"
)

Enum values for PermissionType

func (PermissionType) Values added in v0.29.0

func (PermissionType) Values() []PermissionType

Values returns all known values for PermissionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReservedNameException

type ReservedNameException struct {
	Message *string
}

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

func (*ReservedNameException) Error

func (e *ReservedNameException) Error() string

func (*ReservedNameException) ErrorCode

func (e *ReservedNameException) ErrorCode() string

func (*ReservedNameException) ErrorFault

func (e *ReservedNameException) ErrorFault() smithy.ErrorFault

func (*ReservedNameException) ErrorMessage

func (e *ReservedNameException) ErrorMessage() string

type Resource

type Resource struct {

	// The date indicating when the resource was disabled from Amazon WorkMail use.
	DisabledDate *time.Time

	// The email of the resource.
	Email *string

	// The date indicating when the resource was enabled for Amazon WorkMail use.
	EnabledDate *time.Time

	// The identifier of the resource.
	Id *string

	// The name of the resource.
	Name *string

	// The state of the resource, which can be ENABLED, DISABLED, or DELETED.
	State EntityState

	// The type of the resource: equipment or room.
	Type ResourceType
}

The representation of a resource.

type ResourceNotFoundException added in v0.29.0

type ResourceNotFoundException struct {
	Message *string
}

The resource cannot be found.

func (*ResourceNotFoundException) Error added in v0.29.0

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode added in v0.29.0

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault added in v0.29.0

func (*ResourceNotFoundException) ErrorMessage added in v0.29.0

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType

type ResourceType string
const (
	ResourceTypeRoom      ResourceType = "ROOM"
	ResourceTypeEquipment ResourceType = "EQUIPMENT"
)

Enum values for ResourceType

func (ResourceType) Values added in v0.29.0

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RetentionAction added in v0.29.0

type RetentionAction string
const (
	RetentionActionNone              RetentionAction = "NONE"
	RetentionActionDelete            RetentionAction = "DELETE"
	RetentionActionPermanentlyDelete RetentionAction = "PERMANENTLY_DELETE"
)

Enum values for RetentionAction

func (RetentionAction) Values added in v0.29.0

func (RetentionAction) Values() []RetentionAction

Values returns all known values for RetentionAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Tag added in v0.29.0

type Tag struct {

	// The key of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	//
	// This member is required.
	Value *string
}

Describes a tag applied to a resource.

type TooManyTagsException added in v0.29.0

type TooManyTagsException struct {
	Message *string
}

The resource can have up to 50 user-applied tags.

func (*TooManyTagsException) Error added in v0.29.0

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode added in v0.29.0

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault added in v0.29.0

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage added in v0.29.0

func (e *TooManyTagsException) ErrorMessage() string

type UnsupportedOperationException

type UnsupportedOperationException struct {
	Message *string
}

You can't perform a write operation against a read-only directory.

func (*UnsupportedOperationException) Error

func (*UnsupportedOperationException) ErrorCode

func (e *UnsupportedOperationException) ErrorCode() string

func (*UnsupportedOperationException) ErrorFault

func (*UnsupportedOperationException) ErrorMessage

func (e *UnsupportedOperationException) ErrorMessage() string

type User

type User struct {

	// The date indicating when the user was disabled from Amazon WorkMail use.
	DisabledDate *time.Time

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

	// The email of the user.
	Email *string

	// The date indicating when the user was enabled for Amazon WorkMail use.
	EnabledDate *time.Time

	// The identifier of the user.
	Id *string

	// The name of the user.
	Name *string

	// The state of the user, which can be ENABLED, DISABLED, or DELETED.
	State EntityState

	// The role of the user.
	UserRole UserRole
}

The representation of an Amazon WorkMail user.

type UserRole

type UserRole string
const (
	UserRoleUser       UserRole = "USER"
	UserRoleResource   UserRole = "RESOURCE"
	UserRoleSystemUser UserRole = "SYSTEM_USER"
)

Enum values for UserRole

func (UserRole) Values added in v0.29.0

func (UserRole) Values() []UserRole

Values returns all known values for UserRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL