package types

import "github.com/aws/aws-sdk-go-v2/service/workmail/types"

Index

Types

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 DirectoryServiceAuthenticationFailedException 

type DirectoryServiceAuthenticationFailedException struct {
	Message *string
}

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

func (*DirectoryServiceAuthenticationFailedException) Error 

func (e *DirectoryServiceAuthenticationFailedException) Error() string

func (*DirectoryServiceAuthenticationFailedException) ErrorCode 

func (e *DirectoryServiceAuthenticationFailedException) ErrorCode() string

func (*DirectoryServiceAuthenticationFailedException) ErrorFault 

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

func (*DirectoryServiceAuthenticationFailedException) ErrorMessage 

func (e *DirectoryServiceAuthenticationFailedException) ErrorMessage() string

type DirectoryUnavailableException 

type DirectoryUnavailableException struct {
	Message *string
}

The directory on which you are trying to perform operations isn't available.

func (*DirectoryUnavailableException) Error 

func (e *DirectoryUnavailableException) Error() string

func (*DirectoryUnavailableException) ErrorCode 

func (e *DirectoryUnavailableException) ErrorCode() string

func (*DirectoryUnavailableException) ErrorFault 

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

func (*DirectoryUnavailableException) ErrorMessage 

func (e *DirectoryUnavailableException) ErrorMessage() string

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 (e *EmailAddressInUseException) Error() string

func (*EmailAddressInUseException) ErrorCode 

func (e *EmailAddressInUseException) ErrorCode() string

func (*EmailAddressInUseException) ErrorFault 

func (e *EmailAddressInUseException) ErrorFault() smithy.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 (e *EntityAlreadyRegisteredException) Error() string

func (*EntityAlreadyRegisteredException) ErrorCode 

func (e *EntityAlreadyRegisteredException) ErrorCode() string

func (*EntityAlreadyRegisteredException) ErrorFault 

func (e *EntityAlreadyRegisteredException) ErrorFault() smithy.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

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 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 (e *InvalidConfigurationException) Error() string

func (*InvalidConfigurationException) ErrorCode 

func (e *InvalidConfigurationException) ErrorCode() string

func (*InvalidConfigurationException) ErrorFault 

func (e *InvalidConfigurationException) ErrorFault() smithy.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 (e *InvalidParameterException) ErrorFault() smithy.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 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 (e *MailDomainNotFoundException) Error() string

func (*MailDomainNotFoundException) ErrorCode 

func (e *MailDomainNotFoundException) ErrorCode() string

func (*MailDomainNotFoundException) ErrorFault 

func (e *MailDomainNotFoundException) ErrorFault() smithy.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 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

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 (e *NameAvailabilityException) ErrorFault() smithy.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 (e *OrganizationNotFoundException) Error() string

func (*OrganizationNotFoundException) ErrorCode 

func (e *OrganizationNotFoundException) ErrorCode() string

func (*OrganizationNotFoundException) ErrorFault 

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

func (*OrganizationNotFoundException) ErrorMessage 

func (e *OrganizationNotFoundException) ErrorMessage() string

type OrganizationStateException 

type OrganizationStateException struct {
	Message *string
}

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

func (*OrganizationStateException) Error 

func (e *OrganizationStateException) Error() string

func (*OrganizationStateException) ErrorCode 

func (e *OrganizationStateException) ErrorCode() string

func (*OrganizationStateException) ErrorFault 

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

func (*OrganizationStateException) ErrorMessage 

func (e *OrganizationStateException) ErrorMessage() string

type OrganizationSummary 

type OrganizationSummary struct {

	// The alias associated with the organization.
	Alias *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 (
	PermissionTypeFull_access    PermissionType = "FULL_ACCESS"
	PermissionTypeSend_as        PermissionType = "SEND_AS"
	PermissionTypeSend_on_behalf PermissionType = "SEND_ON_BEHALF"
)

Enum values for PermissionType

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 ResourceType 

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

Enum values for ResourceType

type UnsupportedOperationException 

type UnsupportedOperationException struct {
	Message *string
}

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

func (*UnsupportedOperationException) Error 

func (e *UnsupportedOperationException) Error() string

func (*UnsupportedOperationException) ErrorCode 

func (e *UnsupportedOperationException) ErrorCode() string

func (*UnsupportedOperationException) ErrorFault 

func (e *UnsupportedOperationException) ErrorFault() smithy.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"
	UserRoleSystem_user UserRole = "SYSTEM_USER"
)

Enum values for UserRole

Source Files

enums.go errors.go types.go

Version
v0.27.0
Published
Oct 17, 2020
Platform
linux/amd64
Imports
3 packages
Last checked
1 hour ago –

Tools for package owners.