aws-sdk-go: github.com/aws/aws-sdk-go/service/workmail Index | Files | Directories

package workmail

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

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

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    // MemberTypeGroup is a MemberType enum value
    MemberTypeGroup = "GROUP"

    // MemberTypeUser is a MemberType enum value
    MemberTypeUser = "USER"
)
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"
)
const (
    // ResourceTypeRoom is a ResourceType enum value
    ResourceTypeRoom = "ROOM"

    // ResourceTypeEquipment is a ResourceType enum value
    ResourceTypeEquipment = "EQUIPMENT"
)
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"
)
const (

    // 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 on which you are trying to perform operations isn't available.
    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"

    // 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 (Active or Synchronizing) 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"

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

Service information constants

type AssociateDelegateToResourceInput Uses

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 `type:"string" required:"true"`

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

func (AssociateDelegateToResourceInput) GoString Uses

func (s AssociateDelegateToResourceInput) GoString() string

GoString returns the string representation

func (*AssociateDelegateToResourceInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*AssociateDelegateToResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*AssociateDelegateToResourceInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (AssociateDelegateToResourceInput) String Uses

func (s AssociateDelegateToResourceInput) String() string

String returns the string representation

func (*AssociateDelegateToResourceInput) Validate Uses

func (s *AssociateDelegateToResourceInput) Validate() error

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

type AssociateDelegateToResourceOutput Uses

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

func (AssociateDelegateToResourceOutput) GoString Uses

func (s AssociateDelegateToResourceOutput) GoString() string

GoString returns the string representation

func (AssociateDelegateToResourceOutput) String Uses

func (s AssociateDelegateToResourceOutput) String() string

String returns the string representation

type AssociateMemberToGroupInput Uses

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

func (AssociateMemberToGroupInput) GoString Uses

func (s AssociateMemberToGroupInput) GoString() string

GoString returns the string representation

func (*AssociateMemberToGroupInput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*AssociateMemberToGroupInput) SetMemberId Uses

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

SetMemberId sets the MemberId field's value.

func (*AssociateMemberToGroupInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (AssociateMemberToGroupInput) String Uses

func (s AssociateMemberToGroupInput) String() string

String returns the string representation

func (*AssociateMemberToGroupInput) Validate Uses

func (s *AssociateMemberToGroupInput) Validate() error

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

type AssociateMemberToGroupOutput Uses

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

func (AssociateMemberToGroupOutput) GoString Uses

func (s AssociateMemberToGroupOutput) GoString() string

GoString returns the string representation

func (AssociateMemberToGroupOutput) String Uses

func (s AssociateMemberToGroupOutput) String() string

String returns the string representation

type BookingOptions Uses

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 Uses

func (s BookingOptions) GoString() string

GoString returns the string representation

func (*BookingOptions) SetAutoAcceptRequests Uses

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

SetAutoAcceptRequests sets the AutoAcceptRequests field's value.

func (*BookingOptions) SetAutoDeclineConflictingRequests Uses

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

SetAutoDeclineConflictingRequests sets the AutoDeclineConflictingRequests field's value.

func (*BookingOptions) SetAutoDeclineRecurringRequests Uses

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

SetAutoDeclineRecurringRequests sets the AutoDeclineRecurringRequests field's value.

func (BookingOptions) String Uses

func (s BookingOptions) String() string

String returns the string representation

type CreateAliasInput Uses

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

func (CreateAliasInput) GoString Uses

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetAlias Uses

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

SetAlias sets the Alias field's value.

func (*CreateAliasInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*CreateAliasInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (CreateAliasInput) String Uses

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate Uses

func (s *CreateAliasInput) Validate() error

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

type CreateAliasOutput Uses

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

func (CreateAliasOutput) GoString Uses

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (CreateAliasOutput) String Uses

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateGroupInput Uses

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

func (CreateGroupInput) GoString Uses

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (*CreateGroupInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateGroupInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (CreateGroupInput) String Uses

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate Uses

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput Uses

type CreateGroupOutput struct {

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

func (CreateGroupOutput) GoString Uses

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (*CreateGroupOutput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (CreateGroupOutput) String Uses

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateResourceInput Uses

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 `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 Uses

func (s CreateResourceInput) GoString() string

GoString returns the string representation

func (*CreateResourceInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*CreateResourceInput) SetType Uses

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

SetType sets the Type field's value.

func (CreateResourceInput) String Uses

func (s CreateResourceInput) String() string

String returns the string representation

func (*CreateResourceInput) Validate Uses

func (s *CreateResourceInput) Validate() error

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

type CreateResourceOutput Uses

type CreateResourceOutput struct {

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

func (CreateResourceOutput) GoString Uses

func (s CreateResourceOutput) GoString() string

GoString returns the string representation

func (*CreateResourceOutput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (CreateResourceOutput) String Uses

func (s CreateResourceOutput) String() string

String returns the string representation

type CreateUserInput Uses

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. Simple AD or AD Connector user names have a maximum
    // length of 20. All others have a maximum length of 64.
    //
    // 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 `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 Uses

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetDisplayName Uses

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

SetDisplayName sets the DisplayName field's value.

func (*CreateUserInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateUserInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*CreateUserInput) SetPassword Uses

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

SetPassword sets the Password field's value.

func (CreateUserInput) String Uses

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate Uses

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput Uses

type CreateUserOutput struct {

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

func (CreateUserOutput) GoString Uses

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (*CreateUserOutput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (CreateUserOutput) String Uses

func (s CreateUserOutput) String() string

String returns the string representation

type Delegate Uses

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 Uses

func (s Delegate) GoString() string

GoString returns the string representation

func (*Delegate) SetId Uses

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

SetId sets the Id field's value.

func (*Delegate) SetType Uses

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

SetType sets the Type field's value.

func (Delegate) String Uses

func (s Delegate) String() string

String returns the string representation

type DeleteAliasInput Uses

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

func (DeleteAliasInput) GoString Uses

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (*DeleteAliasInput) SetAlias Uses

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

SetAlias sets the Alias field's value.

func (*DeleteAliasInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*DeleteAliasInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DeleteAliasInput) String Uses

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate Uses

func (s *DeleteAliasInput) Validate() error

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

type DeleteAliasOutput Uses

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

func (DeleteAliasOutput) GoString Uses

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) String Uses

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteGroupInput Uses

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

func (DeleteGroupInput) GoString Uses

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (*DeleteGroupInput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*DeleteGroupInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DeleteGroupInput) String Uses

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate Uses

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput Uses

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

func (DeleteGroupOutput) GoString Uses

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) String Uses

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteMailboxPermissionsInput Uses

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

func (DeleteMailboxPermissionsInput) GoString Uses

func (s DeleteMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*DeleteMailboxPermissionsInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*DeleteMailboxPermissionsInput) SetGranteeId Uses

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

SetGranteeId sets the GranteeId field's value.

func (*DeleteMailboxPermissionsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DeleteMailboxPermissionsInput) String Uses

func (s DeleteMailboxPermissionsInput) String() string

String returns the string representation

func (*DeleteMailboxPermissionsInput) Validate Uses

func (s *DeleteMailboxPermissionsInput) Validate() error

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

type DeleteMailboxPermissionsOutput Uses

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

func (DeleteMailboxPermissionsOutput) GoString Uses

func (s DeleteMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (DeleteMailboxPermissionsOutput) String Uses

func (s DeleteMailboxPermissionsOutput) String() string

String returns the string representation

type DeleteResourceInput Uses

type DeleteResourceInput struct {

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

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

func (DeleteResourceInput) GoString Uses

func (s DeleteResourceInput) GoString() string

GoString returns the string representation

func (*DeleteResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteResourceInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (DeleteResourceInput) String Uses

func (s DeleteResourceInput) String() string

String returns the string representation

func (*DeleteResourceInput) Validate Uses

func (s *DeleteResourceInput) Validate() error

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

type DeleteResourceOutput Uses

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

func (DeleteResourceOutput) GoString Uses

func (s DeleteResourceOutput) GoString() string

GoString returns the string representation

func (DeleteResourceOutput) String Uses

func (s DeleteResourceOutput) String() string

String returns the string representation

type DeleteUserInput Uses

type DeleteUserInput struct {

    // The organization that contains the user to be deleted.
    //
    // OrganizationId is a required field
    OrganizationId *string `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 Uses

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DeleteUserInput) String Uses

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate Uses

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput Uses

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

func (DeleteUserOutput) GoString Uses

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String Uses

func (s DeleteUserOutput) String() string

String returns the string representation

type DeregisterFromWorkMailInput Uses

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

func (DeregisterFromWorkMailInput) GoString Uses

func (s DeregisterFromWorkMailInput) GoString() string

GoString returns the string representation

func (*DeregisterFromWorkMailInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*DeregisterFromWorkMailInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DeregisterFromWorkMailInput) String Uses

func (s DeregisterFromWorkMailInput) String() string

String returns the string representation

func (*DeregisterFromWorkMailInput) Validate Uses

func (s *DeregisterFromWorkMailInput) Validate() error

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

type DeregisterFromWorkMailOutput Uses

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

func (DeregisterFromWorkMailOutput) GoString Uses

func (s DeregisterFromWorkMailOutput) GoString() string

GoString returns the string representation

func (DeregisterFromWorkMailOutput) String Uses

func (s DeregisterFromWorkMailOutput) String() string

String returns the string representation

type DescribeGroupInput Uses

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

func (DescribeGroupInput) GoString Uses

func (s DescribeGroupInput) GoString() string

GoString returns the string representation

func (*DescribeGroupInput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*DescribeGroupInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DescribeGroupInput) String Uses

func (s DescribeGroupInput) String() string

String returns the string representation

func (*DescribeGroupInput) Validate Uses

func (s *DescribeGroupInput) Validate() error

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

type DescribeGroupOutput Uses

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 Uses

func (s DescribeGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeGroupOutput) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeGroupOutput) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*DescribeGroupOutput) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeGroupOutput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*DescribeGroupOutput) SetName Uses

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

SetName sets the Name field's value.

func (*DescribeGroupOutput) SetState Uses

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

SetState sets the State field's value.

func (DescribeGroupOutput) String Uses

func (s DescribeGroupOutput) String() string

String returns the string representation

type DescribeOrganizationInput Uses

type DescribeOrganizationInput struct {

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

func (DescribeOrganizationInput) GoString Uses

func (s DescribeOrganizationInput) GoString() string

GoString returns the string representation

func (*DescribeOrganizationInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DescribeOrganizationInput) String Uses

func (s DescribeOrganizationInput) String() string

String returns the string representation

func (*DescribeOrganizationInput) Validate Uses

func (s *DescribeOrganizationInput) Validate() error

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

type DescribeOrganizationOutput Uses

type DescribeOrganizationOutput struct {

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

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

func (DescribeOrganizationOutput) GoString Uses

func (s DescribeOrganizationOutput) GoString() string

GoString returns the string representation

func (*DescribeOrganizationOutput) SetAlias Uses

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

SetAlias sets the Alias field's value.

func (*DescribeOrganizationOutput) SetCompletedDate Uses

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

SetCompletedDate sets the CompletedDate field's value.

func (*DescribeOrganizationOutput) SetDefaultMailDomain Uses

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

SetDefaultMailDomain sets the DefaultMailDomain field's value.

func (*DescribeOrganizationOutput) SetDirectoryId Uses

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

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeOrganizationOutput) SetDirectoryType Uses

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

SetDirectoryType sets the DirectoryType field's value.

func (*DescribeOrganizationOutput) SetErrorMessage Uses

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeOrganizationOutput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeOrganizationOutput) SetState Uses

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

SetState sets the State field's value.

func (DescribeOrganizationOutput) String Uses

func (s DescribeOrganizationOutput) String() string

String returns the string representation

type DescribeResourceInput Uses

type DescribeResourceInput struct {

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

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

func (DescribeResourceInput) GoString Uses

func (s DescribeResourceInput) GoString() string

GoString returns the string representation

func (*DescribeResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeResourceInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (DescribeResourceInput) String Uses

func (s DescribeResourceInput) String() string

String returns the string representation

func (*DescribeResourceInput) Validate Uses

func (s *DescribeResourceInput) Validate() error

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

type DescribeResourceOutput Uses

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

    // The state of the resource: enabled (registered to Amazon WorkMail) or disabled
    // (deregistered or never registered to WorkMail).
    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 Uses

func (s DescribeResourceOutput) GoString() string

GoString returns the string representation

func (*DescribeResourceOutput) SetBookingOptions Uses

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

SetBookingOptions sets the BookingOptions field's value.

func (*DescribeResourceOutput) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeResourceOutput) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*DescribeResourceOutput) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeResourceOutput) SetName Uses

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

SetName sets the Name field's value.

func (*DescribeResourceOutput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (*DescribeResourceOutput) SetState Uses

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

SetState sets the State field's value.

func (*DescribeResourceOutput) SetType Uses

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

SetType sets the Type field's value.

func (DescribeResourceOutput) String Uses

func (s DescribeResourceOutput) String() string

String returns the string representation

type DescribeUserInput Uses

type DescribeUserInput struct {

    // The identifier for the organization under which the user exists.
    //
    // OrganizationId is a required field
    OrganizationId *string `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 Uses

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DescribeUserInput) String Uses

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate Uses

func (s *DescribeUserInput) Validate() error

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

type DescribeUserOutput Uses

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 Uses

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*DescribeUserOutput) SetDisplayName Uses

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

SetDisplayName sets the DisplayName field's value.

func (*DescribeUserOutput) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*DescribeUserOutput) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*DescribeUserOutput) SetName Uses

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

SetName sets the Name field's value.

func (*DescribeUserOutput) SetState Uses

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

SetState sets the State field's value.

func (*DescribeUserOutput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (*DescribeUserOutput) SetUserRole Uses

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

SetUserRole sets the UserRole field's value.

func (DescribeUserOutput) String Uses

func (s DescribeUserOutput) String() string

String returns the string representation

type DisassociateDelegateFromResourceInput Uses

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 `type:"string" required:"true"`

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

func (DisassociateDelegateFromResourceInput) GoString Uses

func (s DisassociateDelegateFromResourceInput) GoString() string

GoString returns the string representation

func (*DisassociateDelegateFromResourceInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*DisassociateDelegateFromResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DisassociateDelegateFromResourceInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (DisassociateDelegateFromResourceInput) String Uses

func (s DisassociateDelegateFromResourceInput) String() string

String returns the string representation

func (*DisassociateDelegateFromResourceInput) Validate Uses

func (s *DisassociateDelegateFromResourceInput) Validate() error

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

type DisassociateDelegateFromResourceOutput Uses

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

func (DisassociateDelegateFromResourceOutput) GoString Uses

func (s DisassociateDelegateFromResourceOutput) GoString() string

GoString returns the string representation

func (DisassociateDelegateFromResourceOutput) String Uses

func (s DisassociateDelegateFromResourceOutput) String() string

String returns the string representation

type DisassociateMemberFromGroupInput Uses

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

func (DisassociateMemberFromGroupInput) GoString Uses

func (s DisassociateMemberFromGroupInput) GoString() string

GoString returns the string representation

func (*DisassociateMemberFromGroupInput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*DisassociateMemberFromGroupInput) SetMemberId Uses

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

SetMemberId sets the MemberId field's value.

func (*DisassociateMemberFromGroupInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DisassociateMemberFromGroupInput) String Uses

func (s DisassociateMemberFromGroupInput) String() string

String returns the string representation

func (*DisassociateMemberFromGroupInput) Validate Uses

func (s *DisassociateMemberFromGroupInput) Validate() error

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

type DisassociateMemberFromGroupOutput Uses

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

func (DisassociateMemberFromGroupOutput) GoString Uses

func (s DisassociateMemberFromGroupOutput) GoString() string

GoString returns the string representation

func (DisassociateMemberFromGroupOutput) String Uses

func (s DisassociateMemberFromGroupOutput) String() string

String returns the string representation

type GetMailboxDetailsInput Uses

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 `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 Uses

func (s GetMailboxDetailsInput) GoString() string

GoString returns the string representation

func (*GetMailboxDetailsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*GetMailboxDetailsInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (GetMailboxDetailsInput) String Uses

func (s GetMailboxDetailsInput) String() string

String returns the string representation

func (*GetMailboxDetailsInput) Validate Uses

func (s *GetMailboxDetailsInput) Validate() error

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

type GetMailboxDetailsOutput Uses

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 Uses

func (s GetMailboxDetailsOutput) GoString() string

GoString returns the string representation

func (*GetMailboxDetailsOutput) SetMailboxQuota Uses

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

SetMailboxQuota sets the MailboxQuota field's value.

func (*GetMailboxDetailsOutput) SetMailboxSize Uses

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

SetMailboxSize sets the MailboxSize field's value.

func (GetMailboxDetailsOutput) String Uses

func (s GetMailboxDetailsOutput) String() string

String returns the string representation

type Group Uses

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 Uses

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*Group) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*Group) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*Group) SetId Uses

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

SetId sets the Id field's value.

func (*Group) SetName Uses

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

SetName sets the Name field's value.

func (*Group) SetState Uses

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

SetState sets the State field's value.

func (Group) String Uses

func (s Group) String() string

String returns the string representation

type ListAliasesInput Uses

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

func (ListAliasesInput) GoString Uses

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (*ListAliasesInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*ListAliasesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListAliasesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListAliasesInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListAliasesInput) String Uses

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate Uses

func (s *ListAliasesInput) Validate() error

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

type ListAliasesOutput Uses

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 Uses

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (*ListAliasesOutput) SetAliases Uses

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

SetAliases sets the Aliases field's value.

func (*ListAliasesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListAliasesOutput) String Uses

func (s ListAliasesOutput) String() string

String returns the string representation

type ListGroupMembersInput Uses

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

func (ListGroupMembersInput) GoString Uses

func (s ListGroupMembersInput) GoString() string

GoString returns the string representation

func (*ListGroupMembersInput) SetGroupId Uses

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

SetGroupId sets the GroupId field's value.

func (*ListGroupMembersInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListGroupMembersInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListGroupMembersInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListGroupMembersInput) String Uses

func (s ListGroupMembersInput) String() string

String returns the string representation

func (*ListGroupMembersInput) Validate Uses

func (s *ListGroupMembersInput) Validate() error

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

type ListGroupMembersOutput Uses

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 Uses

func (s ListGroupMembersOutput) GoString() string

GoString returns the string representation

func (*ListGroupMembersOutput) SetMembers Uses

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

SetMembers sets the Members field's value.

func (*ListGroupMembersOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListGroupMembersOutput) String Uses

func (s ListGroupMembersOutput) String() string

String returns the string representation

type ListGroupsInput Uses

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

func (ListGroupsInput) GoString Uses

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (*ListGroupsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListGroupsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListGroupsInput) String Uses

func (s ListGroupsInput) String() string

String returns the string representation

func (*ListGroupsInput) Validate Uses

func (s *ListGroupsInput) Validate() error

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

type ListGroupsOutput Uses

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 Uses

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (*ListGroupsOutput) SetGroups Uses

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

SetGroups sets the Groups field's value.

func (*ListGroupsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String Uses

func (s ListGroupsOutput) String() string

String returns the string representation

type ListMailboxPermissionsInput Uses

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

func (ListMailboxPermissionsInput) GoString Uses

func (s ListMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*ListMailboxPermissionsInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*ListMailboxPermissionsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListMailboxPermissionsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListMailboxPermissionsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListMailboxPermissionsInput) String Uses

func (s ListMailboxPermissionsInput) String() string

String returns the string representation

func (*ListMailboxPermissionsInput) Validate Uses

func (s *ListMailboxPermissionsInput) Validate() error

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

type ListMailboxPermissionsOutput Uses

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 Uses

func (s ListMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (*ListMailboxPermissionsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListMailboxPermissionsOutput) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (ListMailboxPermissionsOutput) String Uses

func (s ListMailboxPermissionsOutput) String() string

String returns the string representation

type ListOrganizationsInput Uses

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 Uses

func (s ListOrganizationsInput) GoString() string

GoString returns the string representation

func (*ListOrganizationsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListOrganizationsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListOrganizationsInput) String Uses

func (s ListOrganizationsInput) String() string

String returns the string representation

func (*ListOrganizationsInput) Validate Uses

func (s *ListOrganizationsInput) Validate() error

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

type ListOrganizationsOutput Uses

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 Uses

func (s ListOrganizationsOutput) GoString() string

GoString returns the string representation

func (*ListOrganizationsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListOrganizationsOutput) SetOrganizationSummaries Uses

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

SetOrganizationSummaries sets the OrganizationSummaries field's value.

func (ListOrganizationsOutput) String Uses

func (s ListOrganizationsOutput) String() string

String returns the string representation

type ListResourceDelegatesInput Uses

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 `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 Uses

func (s ListResourceDelegatesInput) GoString() string

GoString returns the string representation

func (*ListResourceDelegatesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListResourceDelegatesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListResourceDelegatesInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*ListResourceDelegatesInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (ListResourceDelegatesInput) String Uses

func (s ListResourceDelegatesInput) String() string

String returns the string representation

func (*ListResourceDelegatesInput) Validate Uses

func (s *ListResourceDelegatesInput) Validate() error

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

type ListResourceDelegatesOutput Uses

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 Uses

func (s ListResourceDelegatesOutput) GoString() string

GoString returns the string representation

func (*ListResourceDelegatesOutput) SetDelegates Uses

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

SetDelegates sets the Delegates field's value.

func (*ListResourceDelegatesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListResourceDelegatesOutput) String Uses

func (s ListResourceDelegatesOutput) String() string

String returns the string representation

type ListResourcesInput Uses

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

func (ListResourcesInput) GoString Uses

func (s ListResourcesInput) GoString() string

GoString returns the string representation

func (*ListResourcesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListResourcesInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListResourcesInput) String Uses

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate Uses

func (s *ListResourcesInput) Validate() error

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

type ListResourcesOutput Uses

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 Uses

func (s ListResourcesOutput) GoString() string

GoString returns the string representation

func (*ListResourcesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListResourcesOutput) SetResources Uses

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

SetResources sets the Resources field's value.

func (ListResourcesOutput) String Uses

func (s ListResourcesOutput) String() string

String returns the string representation

type ListUsersInput Uses

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

func (ListUsersInput) GoString Uses

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListUsersInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (ListUsersInput) String Uses

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate Uses

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput Uses

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 Uses

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUsers Uses

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

SetUsers sets the Users field's value.

func (ListUsersOutput) String Uses

func (s ListUsersOutput) String() string

String returns the string representation

type Member Uses

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 Uses

func (s Member) GoString() string

GoString returns the string representation

func (*Member) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*Member) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*Member) SetId Uses

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

SetId sets the Id field's value.

func (*Member) SetName Uses

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

SetName sets the Name field's value.

func (*Member) SetState Uses

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

SetState sets the State field's value.

func (*Member) SetType Uses

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

SetType sets the Type field's value.

func (Member) String Uses

func (s Member) String() string

String returns the string representation

type OrganizationSummary Uses

type OrganizationSummary struct {

    // The alias associated with the organization.
    Alias *string `min:"1" 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 `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 Uses

func (s OrganizationSummary) GoString() string

GoString returns the string representation

func (*OrganizationSummary) SetAlias Uses

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

SetAlias sets the Alias field's value.

func (*OrganizationSummary) SetErrorMessage Uses

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

SetErrorMessage sets the ErrorMessage field's value.

func (*OrganizationSummary) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*OrganizationSummary) SetState Uses

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

SetState sets the State field's value.

func (OrganizationSummary) String Uses

func (s OrganizationSummary) String() string

String returns the string representation

type Permission Uses

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 Uses

func (s Permission) GoString() string

GoString returns the string representation

func (*Permission) SetGranteeId Uses

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

SetGranteeId sets the GranteeId field's value.

func (*Permission) SetGranteeType Uses

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

SetGranteeType sets the GranteeType field's value.

func (*Permission) SetPermissionValues Uses

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

SetPermissionValues sets the PermissionValues field's value.

func (Permission) String Uses

func (s Permission) String() string

String returns the string representation

type PutMailboxPermissionsInput Uses

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 `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 Uses

func (s PutMailboxPermissionsInput) GoString() string

GoString returns the string representation

func (*PutMailboxPermissionsInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*PutMailboxPermissionsInput) SetGranteeId Uses

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

SetGranteeId sets the GranteeId field's value.

func (*PutMailboxPermissionsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*PutMailboxPermissionsInput) SetPermissionValues Uses

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

SetPermissionValues sets the PermissionValues field's value.

func (PutMailboxPermissionsInput) String Uses

func (s PutMailboxPermissionsInput) String() string

String returns the string representation

func (*PutMailboxPermissionsInput) Validate Uses

func (s *PutMailboxPermissionsInput) Validate() error

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

type PutMailboxPermissionsOutput Uses

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

func (PutMailboxPermissionsOutput) GoString Uses

func (s PutMailboxPermissionsOutput) GoString() string

GoString returns the string representation

func (PutMailboxPermissionsOutput) String Uses

func (s PutMailboxPermissionsOutput) String() string

String returns the string representation

type RegisterToWorkMailInput Uses

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

func (RegisterToWorkMailInput) GoString Uses

func (s RegisterToWorkMailInput) GoString() string

GoString returns the string representation

func (*RegisterToWorkMailInput) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*RegisterToWorkMailInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*RegisterToWorkMailInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (RegisterToWorkMailInput) String Uses

func (s RegisterToWorkMailInput) String() string

String returns the string representation

func (*RegisterToWorkMailInput) Validate Uses

func (s *RegisterToWorkMailInput) Validate() error

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

type RegisterToWorkMailOutput Uses

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

func (RegisterToWorkMailOutput) GoString Uses

func (s RegisterToWorkMailOutput) GoString() string

GoString returns the string representation

func (RegisterToWorkMailOutput) String Uses

func (s RegisterToWorkMailOutput) String() string

String returns the string representation

type ResetPasswordInput Uses

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 `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 Uses

func (s ResetPasswordInput) GoString() string

GoString returns the string representation

func (*ResetPasswordInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*ResetPasswordInput) SetPassword Uses

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

SetPassword sets the Password field's value.

func (*ResetPasswordInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (ResetPasswordInput) String Uses

func (s ResetPasswordInput) String() string

String returns the string representation

func (*ResetPasswordInput) Validate Uses

func (s *ResetPasswordInput) Validate() error

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

type ResetPasswordOutput Uses

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

func (ResetPasswordOutput) GoString Uses

func (s ResetPasswordOutput) GoString() string

GoString returns the string representation

func (ResetPasswordOutput) String Uses

func (s ResetPasswordOutput) String() string

String returns the string representation

type Resource Uses

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 Uses

func (s Resource) GoString() string

GoString returns the string representation

func (*Resource) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*Resource) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*Resource) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*Resource) SetId Uses

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

SetId sets the Id field's value.

func (*Resource) SetName Uses

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

SetName sets the Name field's value.

func (*Resource) SetState Uses

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

SetState sets the State field's value.

func (*Resource) SetType Uses

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

SetType sets the Type field's value.

func (Resource) String Uses

func (s Resource) String() string

String returns the string representation

type UpdateMailboxQuotaInput Uses

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 `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 Uses

func (s UpdateMailboxQuotaInput) GoString() string

GoString returns the string representation

func (*UpdateMailboxQuotaInput) SetMailboxQuota Uses

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

SetMailboxQuota sets the MailboxQuota field's value.

func (*UpdateMailboxQuotaInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*UpdateMailboxQuotaInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (UpdateMailboxQuotaInput) String Uses

func (s UpdateMailboxQuotaInput) String() string

String returns the string representation

func (*UpdateMailboxQuotaInput) Validate Uses

func (s *UpdateMailboxQuotaInput) Validate() error

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

type UpdateMailboxQuotaOutput Uses

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

func (UpdateMailboxQuotaOutput) GoString Uses

func (s UpdateMailboxQuotaOutput) GoString() string

GoString returns the string representation

func (UpdateMailboxQuotaOutput) String Uses

func (s UpdateMailboxQuotaOutput) String() string

String returns the string representation

type UpdatePrimaryEmailAddressInput Uses

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

func (UpdatePrimaryEmailAddressInput) GoString Uses

func (s UpdatePrimaryEmailAddressInput) GoString() string

GoString returns the string representation

func (*UpdatePrimaryEmailAddressInput) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*UpdatePrimaryEmailAddressInput) SetEntityId Uses

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

SetEntityId sets the EntityId field's value.

func (*UpdatePrimaryEmailAddressInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (UpdatePrimaryEmailAddressInput) String Uses

func (s UpdatePrimaryEmailAddressInput) String() string

String returns the string representation

func (*UpdatePrimaryEmailAddressInput) Validate Uses

func (s *UpdatePrimaryEmailAddressInput) Validate() error

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

type UpdatePrimaryEmailAddressOutput Uses

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

func (UpdatePrimaryEmailAddressOutput) GoString Uses

func (s UpdatePrimaryEmailAddressOutput) GoString() string

GoString returns the string representation

func (UpdatePrimaryEmailAddressOutput) String Uses

func (s UpdatePrimaryEmailAddressOutput) String() string

String returns the string representation

type UpdateResourceInput Uses

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 `type:"string" required:"true"`

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

func (UpdateResourceInput) GoString Uses

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (*UpdateResourceInput) SetBookingOptions Uses

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

SetBookingOptions sets the BookingOptions field's value.

func (*UpdateResourceInput) SetName Uses

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

SetName sets the Name field's value.

func (*UpdateResourceInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*UpdateResourceInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (UpdateResourceInput) String Uses

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate Uses

func (s *UpdateResourceInput) Validate() error

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

type UpdateResourceOutput Uses

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

func (UpdateResourceOutput) GoString Uses

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) String Uses

func (s UpdateResourceOutput) String() string

String returns the string representation

type User Uses

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 Uses

func (s User) GoString() string

GoString returns the string representation

func (*User) SetDisabledDate Uses

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

SetDisabledDate sets the DisabledDate field's value.

func (*User) SetDisplayName Uses

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

SetDisplayName sets the DisplayName field's value.

func (*User) SetEmail Uses

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

SetEmail sets the Email field's value.

func (*User) SetEnabledDate Uses

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

SetEnabledDate sets the EnabledDate field's value.

func (*User) SetId Uses

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

SetId sets the Id field's value.

func (*User) SetName Uses

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

SetName sets the Name field's value.

func (*User) SetState Uses

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

SetState sets the State field's value.

func (*User) SetUserRole Uses

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

SetUserRole sets the UserRole field's value.

func (User) String Uses

func (s User) String() string

String returns the string representation

type WorkMail Uses

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 Uses

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:

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

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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) CreateAlias Uses

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 Codes:

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

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAlias

func (*WorkMail) CreateAliasRequest Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

* ErrCodeNameAvailabilityException "NameAvailabilityException"
The user, group, or resource name isn't unique in Amazon WorkMail.

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

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

* ErrCodeReservedNameException "ReservedNameException"
This user, group, or resource name is not allowed in Amazon WorkMail.

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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) CreateResource Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

* ErrCodeNameAvailabilityException "NameAvailabilityException"
The user, group, or resource name isn't unique in Amazon WorkMail.

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

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

* ErrCodeReservedNameException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeNameAvailabilityException "NameAvailabilityException"
The user, group, or resource name isn't unique in Amazon WorkMail.

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

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

* ErrCodeReservedNameException "ReservedNameException"
This user, group, or resource name is not allowed in Amazon WorkMail.

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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) DeleteAlias Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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) DeleteResource Uses

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 Codes:

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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) DeleteUser Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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) DescribeOrganization Uses

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

* ErrCodeOrganizationNotFoundException "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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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) GetMailboxDetails Uses

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 Codes:

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

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

* ErrCodeEntityNotFoundException "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 Uses

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 Uses

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) ListAliases Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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) ListMailboxPermissions Uses

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 Codes:

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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) ListOrganizations Uses

func (c *WorkMail) ListOrganizations(input *ListOrganizationsInput) (*ListOrganizationsOutput, error)

ListOrganizations API operation for Amazon WorkMail.

Returns summaries of the customer's non-deleted 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 Codes:

* ErrCodeInvalidParameterException "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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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) ListUsers Uses

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Uses

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) PutMailboxPermissions Uses

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 Codes:

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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) RegisterToWorkMail Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

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

* ErrCodeEntityStateException "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.

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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) UpdateMailboxQuota Uses

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

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

* ErrCodeEntityStateException "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 Uses

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 Uses

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) UpdatePrimaryEmailAddress Uses

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 Codes:

* ErrCodeDirectoryServiceAuthenticationFailedException "DirectoryServiceAuthenticationFailedException"
The directory service doesn't recognize the credentials supplied by WorkMail.

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more of the input parameters don't match the service's restrictions.

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

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

* ErrCodeUnsupportedOperationException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeDirectoryUnavailableException "DirectoryUnavailableException"
The directory on which you are trying to perform operations isn't available.

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

* ErrCodeEntityStateException "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.

* ErrCodeInvalidConfigurationException "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.

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

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

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

* ErrCodeNameAvailabilityException "NameAvailabilityException"
The user, group, or resource name isn't unique in Amazon WorkMail.

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

* ErrCodeOrganizationStateException "OrganizationStateException"
The organization must have a valid state (Active or Synchronizing) 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 Uses

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 Uses

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.

Directories

PathSynopsis
workmailifacePackage workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.

Package workmail imports 9 packages (graph) and is imported by 13 packages. Updated 2019-06-03. Refresh now. Tools for package owners.