types

package
v1.30.8 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 4 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

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

	// 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

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

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

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

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

A rule that controls access to an 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 

func (AccessControlRuleEffect) Values() []AccessControlRuleEffect

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 AccessEffect added in v1.17.0 

type AccessEffect string
const (
	AccessEffectAllow AccessEffect = "ALLOW"
	AccessEffectDeny  AccessEffect = "DENY"
)

Enum values for AccessEffect

func (AccessEffect) Values added in v1.17.0 

func (AccessEffect) Values() []AccessEffect

Values returns all known values for AccessEffect. 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 AvailabilityConfiguration added in v1.16.0 

type AvailabilityConfiguration struct {

	// The date and time at which the availability configuration was created.
	DateCreated *time.Time

	// The date and time at which the availability configuration was last modified.
	DateModified *time.Time

	// Displays the domain to which the provider applies.
	DomainName *string

	// If ProviderType is EWS , then this field contains
	// RedactedEwsAvailabilityProvider . Otherwise, it is not required.
	EwsProvider *RedactedEwsAvailabilityProvider

	// If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider .
	// Otherwise, it is not required.
	LambdaProvider *LambdaAvailabilityProvider

	// Displays the provider type that applies to this domain.
	ProviderType AvailabilityProviderType
	// contains filtered or unexported fields
}

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

type AvailabilityProviderType added in v1.16.0 

type AvailabilityProviderType string
const (
	AvailabilityProviderTypeEws    AvailabilityProviderType = "EWS"
	AvailabilityProviderTypeLambda AvailabilityProviderType = "LAMBDA"
)

Enum values for AvailabilityProviderType

func (AvailabilityProviderType) Values added in v1.16.0 

func (AvailabilityProviderType) Values() []AvailabilityProviderType

Values returns all known values for AvailabilityProviderType. 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

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 DnsRecord added in v1.8.0 

type DnsRecord struct {

	// The DNS hostname.- For example, domain.example.com .
	Hostname *string

	// The RFC 1035 record type. Possible values: CNAME , A , MX .
	Type *string

	// The value returned by the DNS for a query to that hostname and record type.
	Value *string
	// contains filtered or unexported fields
}

A DNS record uploaded to your DNS provider.

type DnsRecordVerificationStatus added in v1.8.0 

type DnsRecordVerificationStatus string
const (
	DnsRecordVerificationStatusPending  DnsRecordVerificationStatus = "PENDING"
	DnsRecordVerificationStatusVerified DnsRecordVerificationStatus = "VERIFIED"
	DnsRecordVerificationStatusFailed   DnsRecordVerificationStatus = "FAILED"
)

Enum values for DnsRecordVerificationStatus

func (DnsRecordVerificationStatus) Values added in v1.8.0 

func (DnsRecordVerificationStatus) Values() []DnsRecordVerificationStatus

Values returns all known values for DnsRecordVerificationStatus. 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 Domain added in v0.29.0 

type Domain struct {

	// The fully qualified domain name.
	//
	// This member is required.
	DomainName *string

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

The domain to associate with an 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 domainin the WorkMail Administrator Guide.

type EmailAddressInUseException 

type EmailAddressInUseException struct {
	Message *string

	ErrorCodeOverride *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) 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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *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) 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 EntityType added in v1.20.0 

type EntityType string
const (
	EntityTypeGroup    EntityType = "GROUP"
	EntityTypeUser     EntityType = "USER"
	EntityTypeResource EntityType = "RESOURCE"
)

Enum values for EntityType

func (EntityType) Values added in v1.20.0 

func (EntityType) Values() []EntityType

Values returns all known values for EntityType. 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 EwsAvailabilityProvider added in v1.16.0 

type EwsAvailabilityProvider struct {

	// The endpoint of the remote EWS server.
	//
	// This member is required.
	EwsEndpoint *string

	// The password used to authenticate the remote EWS server.
	//
	// This member is required.
	EwsPassword *string

	// The username used to authenticate the remote EWS server.
	//
	// This member is required.
	EwsUsername *string
	// contains filtered or unexported fields
}

Describes an EWS based availability provider. This is only used as input to the service.

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 number of days for which the folder-configuration action applies.
	Period *int32
	// contains filtered or unexported fields
}

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 WorkMail use.
	DisabledDate *time.Time

	// The email of the group.
	Email *string

	// The date indicating when the group was enabled for 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
	// contains filtered or unexported fields
}

The representation of an WorkMail group.

type GroupIdentifier added in v1.20.0 

type GroupIdentifier struct {

	// Group ID that matched the group.
	GroupId *string

	// Group name that matched the group.
	GroupName *string
	// contains filtered or unexported fields
}

The identifier that contains the Group ID and name of a group.

type IdentityCenterConfiguration added in v1.30.0 

type IdentityCenterConfiguration struct {

	//  The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail.
	// Must be created by the WorkMail API, see CreateIdentityCenterApplication.
	//
	// This member is required.
	ApplicationArn *string

	//  The Amazon Resource Name (ARN) of the of IAM Identity Center instance. Must be
	// in the same AWS account and region as WorkMail organization.
	//
	// This member is required.
	InstanceArn *string
	// contains filtered or unexported fields
}

The IAM Identity Center configuration.

type IdentityProviderAuthenticationMode added in v1.30.0 

type IdentityProviderAuthenticationMode string
const (
	IdentityProviderAuthenticationModeIdentityProviderOnly         IdentityProviderAuthenticationMode = "IDENTITY_PROVIDER_ONLY"
	IdentityProviderAuthenticationModeIdentityProviderAndDirectory IdentityProviderAuthenticationMode = "IDENTITY_PROVIDER_AND_DIRECTORY"
)

Enum values for IdentityProviderAuthenticationMode

func (IdentityProviderAuthenticationMode) Values added in v1.30.0 

func (IdentityProviderAuthenticationMode) Values() []IdentityProviderAuthenticationMode

Values returns all known values for IdentityProviderAuthenticationMode. 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 ImpersonationMatchedRule added in v1.17.0 

type ImpersonationMatchedRule struct {

	// The ID of the rule that matched the input
	ImpersonationRuleId *string

	// The name of the rule that matched the input.
	Name *string
	// contains filtered or unexported fields
}

The impersonation rule that matched the input.

type ImpersonationRole added in v1.17.0 

type ImpersonationRole struct {

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

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

	// The identifier of the impersonation role.
	ImpersonationRoleId *string

	// The impersonation role name.
	Name *string

	// The impersonation role type.
	Type ImpersonationRoleType
	// contains filtered or unexported fields
}

An impersonation role for the given WorkMail organization.

type ImpersonationRoleType added in v1.17.0 

type ImpersonationRoleType string
const (
	ImpersonationRoleTypeFullAccess ImpersonationRoleType = "FULL_ACCESS"
	ImpersonationRoleTypeReadOnly   ImpersonationRoleType = "READ_ONLY"
)

Enum values for ImpersonationRoleType

func (ImpersonationRoleType) Values added in v1.17.0 

func (ImpersonationRoleType) Values() []ImpersonationRoleType

Values returns all known values for ImpersonationRoleType. 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 ImpersonationRule added in v1.17.0 

type ImpersonationRule struct {

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

	// The identifier of the rule.
	//
	// This member is required.
	ImpersonationRuleId *string

	// The rule description.
	Description *string

	// The rule name.
	Name *string

	// A list of user IDs that don't match the rule.
	NotTargetUsers []string

	// A list of user IDs that match the rule.
	TargetUsers []string
	// contains filtered or unexported fields
}

The rules for the given impersonation role.

type InvalidConfigurationException 

type InvalidConfigurationException struct {
	Message *string

	ErrorCodeOverride *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) 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 InvalidCustomSesConfigurationException added in v1.8.0 

type InvalidCustomSesConfigurationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.

func (*InvalidCustomSesConfigurationException) Error added in v1.8.0 

func (e *InvalidCustomSesConfigurationException) Error() string

func (*InvalidCustomSesConfigurationException) ErrorCode added in v1.8.0 

func (e *InvalidCustomSesConfigurationException) ErrorCode() string

func (*InvalidCustomSesConfigurationException) ErrorFault added in v1.8.0 

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

func (*InvalidCustomSesConfigurationException) ErrorMessage added in v1.8.0 

func (e *InvalidCustomSesConfigurationException) ErrorMessage() string

type InvalidParameterException 

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *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) 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 LambdaAvailabilityProvider added in v1.16.0 

type LambdaAvailabilityProvider struct {

	// The Amazon Resource Name (ARN) of the Lambda that acts as the availability
	// provider.
	//
	// This member is required.
	LambdaArn *string
	// contains filtered or unexported fields
}

Describes a Lambda based availability provider.

type LimitExceededException added in v0.29.0 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 ListGroupsFilters added in v1.20.0 

type ListGroupsFilters struct {

	// Filters only groups with the provided name prefix.
	NamePrefix *string

	// Filters only groups with the provided primary email prefix.
	PrimaryEmailPrefix *string

	// Filters only groups with the provided state.
	State EntityState
	// contains filtered or unexported fields
}
Filtering options for ListGroups operation. This is only used as input to

Operation.

type ListGroupsForEntityFilters added in v1.20.0 

type ListGroupsForEntityFilters struct {

	// Filters only group names that start with the provided name prefix.
	GroupNamePrefix *string
	// contains filtered or unexported fields
}
Filtering options for ListGroupsForEntity operation. This is only used as

input to Operation.

type ListResourcesFilters added in v1.20.0 

type ListResourcesFilters struct {

	// Filters only resource that start with the entered name prefix .
	NamePrefix *string

	// Filters only resource with the provided primary email prefix.
	PrimaryEmailPrefix *string

	// Filters only resource with the provided state.
	State EntityState
	// contains filtered or unexported fields
}

Filtering options for ListResources operation. This is only used as input to Operation.

type ListUsersFilters added in v1.20.0 

type ListUsersFilters struct {

	// Filters only users with the provided display name prefix.
	DisplayNamePrefix *string

	// Filters only users with the ID from the IAM Identity Center.
	IdentityProviderUserIdPrefix *string

	// Filters only users with the provided email prefix.
	PrimaryEmailPrefix *string

	// Filters only users with the provided state.
	State EntityState

	// Filters only users with the provided username prefix.
	UsernamePrefix *string
	// contains filtered or unexported fields
}
Filtering options for ListUsers operation. This is only used as input to

Operation.

type MailDomainInUseException added in v1.8.0 

type MailDomainInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The domain you're trying to change is in use by another user or organization in your account. See the error message for details.

func (*MailDomainInUseException) Error added in v1.8.0 

func (e *MailDomainInUseException) Error() string

func (*MailDomainInUseException) ErrorCode added in v1.8.0 

func (e *MailDomainInUseException) ErrorCode() string

func (*MailDomainInUseException) ErrorFault added in v1.8.0 

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

func (*MailDomainInUseException) ErrorMessage added in v1.8.0 

func (e *MailDomainInUseException) ErrorMessage() string

type MailDomainNotFoundException 

type MailDomainNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The domain specified is not found in your 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

	ErrorCodeOverride *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) 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 MailDomainSummary added in v1.8.0 

type MailDomainSummary struct {

	// Whether the domain is default or not.
	DefaultDomain bool

	// The domain name.
	DomainName *string
	// contains filtered or unexported fields
}

The data for a given domain.

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

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 

func (MailboxExportJobState) Values() []MailboxExportJobState

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 WorkMail use.
	DisabledDate *time.Time

	// The date indicating when the member was enabled for 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
	// contains filtered or unexported fields
}

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 MobileDeviceAccessMatchedRule added in v1.2.0 

type MobileDeviceAccessMatchedRule struct {

	// Identifier of the rule that a simulated user matches.
	MobileDeviceAccessRuleId *string

	// Name of a rule that a simulated user matches.
	Name *string
	// contains filtered or unexported fields
}

The rule that a simulated user matches.

type MobileDeviceAccessOverride added in v1.6.0 

type MobileDeviceAccessOverride struct {

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

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

	// A description of the override.
	Description *string

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

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

	// The WorkMail user to which the access override applies.
	UserId *string
	// contains filtered or unexported fields
}

The override object.

type MobileDeviceAccessRule added in v1.2.0 

type MobileDeviceAccessRule struct {

	// The date and time at which an access rule was created.
	DateCreated *time.Time

	// The date and time at which an access rule was modified.
	DateModified *time.Time

	// The description of a mobile access rule.
	Description *string

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

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

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

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

	// The effect of the rule when it matches. Allowed values are ALLOW or DENY .
	Effect MobileDeviceAccessRuleEffect

	// The ID assigned to a mobile access rule.
	MobileDeviceAccessRuleId *string

	// The name of a mobile access rule.
	Name *string

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

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

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

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

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

type MobileDeviceAccessRuleEffect added in v1.2.0 

type MobileDeviceAccessRuleEffect string
const (
	MobileDeviceAccessRuleEffectAllow MobileDeviceAccessRuleEffect = "ALLOW"
	MobileDeviceAccessRuleEffectDeny  MobileDeviceAccessRuleEffect = "DENY"
)

Enum values for MobileDeviceAccessRuleEffect

func (MobileDeviceAccessRuleEffect) Values added in v1.2.0 

func (MobileDeviceAccessRuleEffect) Values() []MobileDeviceAccessRuleEffect

Values returns all known values for MobileDeviceAccessRuleEffect. 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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The user, group, or resource name isn't unique in 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

	ErrorCodeOverride *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) 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

	ErrorCodeOverride *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) 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 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
	// contains filtered or unexported fields
}

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

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 PersonalAccessTokenConfiguration added in v1.30.0 

type PersonalAccessTokenConfiguration struct {

	//  The status of the Personal Access Token allowed for the organization.
	//
	//   - Active - Mailbox users can login to the web application and choose Settings
	//   to see the new Personal Access Tokens page to create and delete the Personal
	//   Access Tokens. Mailbox users can use the Personal Access Tokens to set up
	//   mailbox connection from desktop or mobile email clients.
	//
	//   - Inactive - Personal Access Tokens are disabled for your organization.
	//   Mailbox users can’t create, list, or delete Personal Access Tokens and can’t use
	//   them to connect to their mailboxes from desktop or mobile email clients.
	//
	// This member is required.
	Status PersonalAccessTokenConfigurationStatus

	//  The validity of the Personal Access Token status in days.
	LifetimeInDays *int32
	// contains filtered or unexported fields
}

Displays the Personal Access Token status.

type PersonalAccessTokenConfigurationStatus added in v1.30.0 

type PersonalAccessTokenConfigurationStatus string
const (
	PersonalAccessTokenConfigurationStatusActive   PersonalAccessTokenConfigurationStatus = "ACTIVE"
	PersonalAccessTokenConfigurationStatusInactive PersonalAccessTokenConfigurationStatus = "INACTIVE"
)

Enum values for PersonalAccessTokenConfigurationStatus

func (PersonalAccessTokenConfigurationStatus) Values added in v1.30.0 

func (PersonalAccessTokenConfigurationStatus) Values() []PersonalAccessTokenConfigurationStatus

Values returns all known values for PersonalAccessTokenConfigurationStatus. 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 PersonalAccessTokenSummary added in v1.30.0 

type PersonalAccessTokenSummary struct {

	//  The date when the Personal Access Token was created.
	DateCreated *time.Time

	//  The date when the Personal Access Token was last used.
	DateLastUsed *time.Time

	//  The date when the Personal Access Token will expire.
	ExpiresTime *time.Time

	//  The name of the Personal Access Token.
	Name *string

	//  The ID of the Personal Access Token.
	PersonalAccessTokenId *string

	//  Lists all the Personal Access Token permissions for a mailbox.
	Scopes []string

	//  The user ID of the WorkMail user associated with the Personal Access Token.
	UserId *string
	// contains filtered or unexported fields
}

The summary of the Personal Access Token.

type RedactedEwsAvailabilityProvider added in v1.16.0 

type RedactedEwsAvailabilityProvider struct {

	// The endpoint of the remote EWS server.
	EwsEndpoint *string

	// The username used to authenticate the remote EWS server.
	EwsUsername *string
	// contains filtered or unexported fields
}

Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.

type ReservedNameException 

type ReservedNameException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This user, group, or resource name is not allowed in 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 {

	// Resource description.
	Description *string

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

	// The email of the resource.
	Email *string

	// The date indicating when the resource was enabled for 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
	// contains filtered or unexported fields
}

The representation of a resource.

type ResourceNotFoundException added in v0.29.0 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

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
	// contains filtered or unexported fields
}

Describes a tag applied to a resource.

type TooManyTagsException added in v0.29.0 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 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 WorkMail use.
	EnabledDate *time.Time

	// The identifier of the user.
	Id *string

	// Identity store ID from the IAM Identity Center. If this parameter is empty it
	// will be updated automatically when the user logs in for the first time to the
	// mailbox associated with WorkMail.
	IdentityProviderIdentityStoreId *string

	// User ID from the IAM Identity Center. If this parameter is empty it will be
	// updated automatically when the user logs in for the first time to the mailbox
	// associated with WorkMail.
	IdentityProviderUserId *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
	// contains filtered or unexported fields
}

The representation of an WorkMail user.

type UserRole 

type UserRole string
const (
	UserRoleUser       UserRole = "USER"
	UserRoleResource   UserRole = "RESOURCE"
	UserRoleSystemUser UserRole = "SYSTEM_USER"
	UserRoleRemoteUser UserRole = "REMOTE_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.

Source Files

View all Source files

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.