workmail

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Mar 8, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

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

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon 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 Amazon WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon 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 Amazon WorkMail with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source
const (

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

	// ErrCodeDirectoryUnavailableException for service response error code
	// "DirectoryUnavailableException".
	//
	// The directory that you are trying to perform operations on 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 entity is valid, but it does not exist in
	// your organization.
	ErrCodeEntityNotFoundException = "EntityNotFoundException"

	// ErrCodeEntityStateException for service response error code
	// "EntityStateException".
	//
	// You are performing an operation on an entity that isn't in the expected state,
	// such as trying to update a deleted 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 it 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 entity (user, group, or user) 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 entities.
	ErrCodeOrganizationStateException = "OrganizationStateException"

	// ErrCodeReservedNameException for service response error code
	// "ReservedNameException".
	//
	// This entity 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"
)
View Source
const (
	ServiceName = "workmail"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateDelegateToResourceInput

type AssociateDelegateToResourceInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceRequest

func (AssociateDelegateToResourceInput) GoString

GoString returns the string representation

func (AssociateDelegateToResourceInput) String

String returns the string representation

func (*AssociateDelegateToResourceInput) Validate

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

type AssociateDelegateToResourceOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceResponse

func (AssociateDelegateToResourceOutput) GoString

GoString returns the string representation

func (AssociateDelegateToResourceOutput) SDKResponseMetadata

func (s AssociateDelegateToResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (AssociateDelegateToResourceOutput) String

String returns the string representation

type AssociateDelegateToResourceRequest

type AssociateDelegateToResourceRequest struct {
	*aws.Request
	Input *AssociateDelegateToResourceInput
	Copy  func(*AssociateDelegateToResourceInput) AssociateDelegateToResourceRequest
}

AssociateDelegateToResourceRequest is a API request type for the AssociateDelegateToResource API operation.

func (AssociateDelegateToResourceRequest) Send

Send marshals and sends the AssociateDelegateToResource API request.

type AssociateMemberToGroupInput

type AssociateMemberToGroupInput struct {

	// The group for which the member is associated.
	//
	// GroupId is a required field
	GroupId *string `min:"12" type:"string" required:"true"`

	// The member 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupRequest

func (AssociateMemberToGroupInput) GoString

func (s AssociateMemberToGroupInput) GoString() string

GoString returns the string representation

func (AssociateMemberToGroupInput) String

String returns the string representation

func (*AssociateMemberToGroupInput) Validate

func (s *AssociateMemberToGroupInput) Validate() error

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

type AssociateMemberToGroupOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupResponse

func (AssociateMemberToGroupOutput) GoString

func (s AssociateMemberToGroupOutput) GoString() string

GoString returns the string representation

func (AssociateMemberToGroupOutput) SDKResponseMetadata

func (s AssociateMemberToGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (AssociateMemberToGroupOutput) String

String returns the string representation

type AssociateMemberToGroupRequest

type AssociateMemberToGroupRequest struct {
	*aws.Request
	Input *AssociateMemberToGroupInput
	Copy  func(*AssociateMemberToGroupInput) AssociateMemberToGroupRequest
}

AssociateMemberToGroupRequest is a API request type for the AssociateMemberToGroup API operation.

func (AssociateMemberToGroupRequest) Send

Send marshals and sends the AssociateMemberToGroup API request.

type BookingOptions

type BookingOptions struct {

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

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

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

At least one delegate must be associated to the resource to disable automatic replies from the resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/BookingOptions

func (BookingOptions) GoString

func (s BookingOptions) GoString() string

GoString returns the string representation

func (BookingOptions) String

func (s BookingOptions) String() string

String returns the string representation

type CreateAliasInput

type CreateAliasInput struct {

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

	// The alias is added to this Amazon WorkMail entity.
	//
	// EntityId is a required field
	EntityId *string `min:"12" type:"string" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasRequest

func (CreateAliasInput) GoString

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (CreateAliasInput) String

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate

func (s *CreateAliasInput) Validate() error

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

type CreateAliasOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasResponse

func (CreateAliasOutput) GoString

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (CreateAliasOutput) SDKResponseMetadata

func (s CreateAliasOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateAliasOutput) String

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateAliasRequest

type CreateAliasRequest struct {
	*aws.Request
	Input *CreateAliasInput
	Copy  func(*CreateAliasInput) CreateAliasRequest
}

CreateAliasRequest is a API request type for the CreateAlias API operation.

func (CreateAliasRequest) Send

Send marshals and sends the CreateAlias API request.

type CreateGroupInput

type CreateGroupInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupRequest

func (CreateGroupInput) GoString

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (CreateGroupInput) String

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput

type CreateGroupOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupResponse

func (CreateGroupOutput) GoString

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (CreateGroupOutput) SDKResponseMetadata

func (s CreateGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateGroupOutput) String

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateGroupRequest

type CreateGroupRequest struct {
	*aws.Request
	Input *CreateGroupInput
	Copy  func(*CreateGroupInput) CreateGroupRequest
}

CreateGroupRequest is a API request type for the CreateGroup API operation.

func (CreateGroupRequest) Send

Send marshals and sends the CreateGroup API request.

type CreateResourceInput

type CreateResourceInput struct {

	// The name of the created 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 created resource.
	//
	// Type is a required field
	Type ResourceType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceRequest

func (CreateResourceInput) GoString

func (s CreateResourceInput) GoString() string

GoString returns the string representation

func (CreateResourceInput) String

func (s CreateResourceInput) String() string

String returns the string representation

func (*CreateResourceInput) Validate

func (s *CreateResourceInput) Validate() error

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

type CreateResourceOutput

type CreateResourceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceResponse

func (CreateResourceOutput) GoString

func (s CreateResourceOutput) GoString() string

GoString returns the string representation

func (CreateResourceOutput) SDKResponseMetadata

func (s CreateResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateResourceOutput) String

func (s CreateResourceOutput) String() string

String returns the string representation

type CreateResourceRequest

type CreateResourceRequest struct {
	*aws.Request
	Input *CreateResourceInput
	Copy  func(*CreateResourceInput) CreateResourceRequest
}

CreateResourceRequest is a API request type for the CreateResource API operation.

func (CreateResourceRequest) Send

Send marshals and sends the CreateResource API request.

type CreateUserInput

type CreateUserInput struct {

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

	// The name for the user to be created.
	//
	// 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 user to be created.
	//
	// Password is a required field
	Password *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserRequest

func (CreateUserInput) GoString

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (CreateUserInput) String

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput

type CreateUserOutput struct {

	// The information regarding the newly created user.
	UserId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserResponse

func (CreateUserOutput) GoString

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (CreateUserOutput) SDKResponseMetadata

func (s CreateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateUserOutput) String

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is a API request type for the CreateUser API operation.

func (CreateUserRequest) Send

Send marshals and sends the CreateUser API request.

type Delegate

type Delegate struct {

	// The identifier for the user or group is 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 MemberType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The name of the attribute, which is one of the values defined in the UserAttribute enumeration. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Delegate

func (Delegate) GoString

func (s Delegate) GoString() string

GoString returns the string representation

func (Delegate) String

func (s Delegate) String() string

String returns the string representation

type DeleteAliasInput

type DeleteAliasInput struct {

	// The aliases to be removed from the user's set of aliases. Duplicate entries
	// in the list are collapsed into single entries (the list is transformed into
	// a set).
	//
	// Alias is a required field
	Alias *string `min:"1" type:"string" required:"true"`

	// The identifier for the Amazon WorkMail entity 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasRequest

func (DeleteAliasInput) GoString

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (DeleteAliasInput) String

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate

func (s *DeleteAliasInput) Validate() error

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

type DeleteAliasOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasResponse

func (DeleteAliasOutput) GoString

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) SDKResponseMetadata

func (s DeleteAliasOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteAliasOutput) String

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteAliasRequest

type DeleteAliasRequest struct {
	*aws.Request
	Input *DeleteAliasInput
	Copy  func(*DeleteAliasInput) DeleteAliasRequest
}

DeleteAliasRequest is a API request type for the DeleteAlias API operation.

func (DeleteAliasRequest) Send

Send marshals and sends the DeleteAlias API request.

type DeleteGroupInput

type DeleteGroupInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupRequest

func (DeleteGroupInput) GoString

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (DeleteGroupInput) String

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupResponse

func (DeleteGroupOutput) GoString

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) SDKResponseMetadata

func (s DeleteGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteGroupOutput) String

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteGroupRequest

type DeleteGroupRequest struct {
	*aws.Request
	Input *DeleteGroupInput
	Copy  func(*DeleteGroupInput) DeleteGroupRequest
}

DeleteGroupRequest is a API request type for the DeleteGroup API operation.

func (DeleteGroupRequest) Send

Send marshals and sends the DeleteGroup API request.

type DeleteResourceInput

type DeleteResourceInput struct {

	// The identifier associated with the organization for 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceRequest

func (DeleteResourceInput) GoString

func (s DeleteResourceInput) GoString() string

GoString returns the string representation

func (DeleteResourceInput) String

func (s DeleteResourceInput) String() string

String returns the string representation

func (*DeleteResourceInput) Validate

func (s *DeleteResourceInput) Validate() error

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

type DeleteResourceOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceResponse

func (DeleteResourceOutput) GoString

func (s DeleteResourceOutput) GoString() string

GoString returns the string representation

func (DeleteResourceOutput) SDKResponseMetadata

func (s DeleteResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteResourceOutput) String

func (s DeleteResourceOutput) String() string

String returns the string representation

type DeleteResourceRequest

type DeleteResourceRequest struct {
	*aws.Request
	Input *DeleteResourceInput
	Copy  func(*DeleteResourceInput) DeleteResourceRequest
}

DeleteResourceRequest is a API request type for the DeleteResource API operation.

func (DeleteResourceRequest) Send

Send marshals and sends the DeleteResource API request.

type DeleteUserInput

type DeleteUserInput struct {

	// The organization that contains the user.
	//
	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserRequest

func (DeleteUserInput) GoString

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (DeleteUserInput) String

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserResponse

func (DeleteUserOutput) GoString

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) SDKResponseMetadata

func (s DeleteUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUserOutput) String

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is a API request type for the DeleteUser API operation.

func (DeleteUserRequest) Send

Send marshals and sends the DeleteUser API request.

type DeregisterFromWorkMailInput

type DeregisterFromWorkMailInput struct {

	// The identifier for the entity 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailRequest

func (DeregisterFromWorkMailInput) GoString

func (s DeregisterFromWorkMailInput) GoString() string

GoString returns the string representation

func (DeregisterFromWorkMailInput) String

String returns the string representation

func (*DeregisterFromWorkMailInput) Validate

func (s *DeregisterFromWorkMailInput) Validate() error

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

type DeregisterFromWorkMailOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailResponse

func (DeregisterFromWorkMailOutput) GoString

func (s DeregisterFromWorkMailOutput) GoString() string

GoString returns the string representation

func (DeregisterFromWorkMailOutput) SDKResponseMetadata

func (s DeregisterFromWorkMailOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeregisterFromWorkMailOutput) String

String returns the string representation

type DeregisterFromWorkMailRequest

type DeregisterFromWorkMailRequest struct {
	*aws.Request
	Input *DeregisterFromWorkMailInput
	Copy  func(*DeregisterFromWorkMailInput) DeregisterFromWorkMailRequest
}

DeregisterFromWorkMailRequest is a API request type for the DeregisterFromWorkMail API operation.

func (DeregisterFromWorkMailRequest) Send

Send marshals and sends the DeregisterFromWorkMail API request.

type DescribeGroupInput

type DescribeGroupInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupRequest

func (DescribeGroupInput) GoString

func (s DescribeGroupInput) GoString() string

GoString returns the string representation

func (DescribeGroupInput) String

func (s DescribeGroupInput) String() string

String returns the string representation

func (*DescribeGroupInput) Validate

func (s *DescribeGroupInput) Validate() error

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

type DescribeGroupOutput

type DescribeGroupOutput struct {

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

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

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

	// 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 Amazon WorkMail).
	State EntityState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupResponse

func (DescribeGroupOutput) GoString

func (s DescribeGroupOutput) GoString() string

GoString returns the string representation

func (DescribeGroupOutput) SDKResponseMetadata

func (s DescribeGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeGroupOutput) String

func (s DescribeGroupOutput) String() string

String returns the string representation

type DescribeGroupRequest

type DescribeGroupRequest struct {
	*aws.Request
	Input *DescribeGroupInput
	Copy  func(*DescribeGroupInput) DescribeGroupRequest
}

DescribeGroupRequest is a API request type for the DescribeGroup API operation.

func (DescribeGroupRequest) Send

Send marshals and sends the DescribeGroup API request.

type DescribeOrganizationInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationRequest

func (DescribeOrganizationInput) GoString

func (s DescribeOrganizationInput) GoString() string

GoString returns the string representation

func (DescribeOrganizationInput) String

func (s DescribeOrganizationInput) String() string

String returns the string representation

func (*DescribeOrganizationInput) Validate

func (s *DescribeOrganizationInput) Validate() error

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

type DescribeOrganizationOutput

type DescribeOrganizationOutput struct {

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

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

	// 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 Amazon WorkMail organization.
	DirectoryType *string `type:"string"`

	// The (optional) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationResponse

func (DescribeOrganizationOutput) GoString

func (s DescribeOrganizationOutput) GoString() string

GoString returns the string representation

func (DescribeOrganizationOutput) SDKResponseMetadata

func (s DescribeOrganizationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeOrganizationOutput) String

String returns the string representation

type DescribeOrganizationRequest

type DescribeOrganizationRequest struct {
	*aws.Request
	Input *DescribeOrganizationInput
	Copy  func(*DescribeOrganizationInput) DescribeOrganizationRequest
}

DescribeOrganizationRequest is a API request type for the DescribeOrganization API operation.

func (DescribeOrganizationRequest) Send

Send marshals and sends the DescribeOrganization API request.

type DescribeResourceInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceRequest

func (DescribeResourceInput) GoString

func (s DescribeResourceInput) GoString() string

GoString returns the string representation

func (DescribeResourceInput) String

func (s DescribeResourceInput) String() string

String returns the string representation

func (*DescribeResourceInput) Validate

func (s *DescribeResourceInput) Validate() error

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

type DescribeResourceOutput

type DescribeResourceOutput struct {

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

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

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

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

	// 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 Amazon WorkMail).
	State EntityState `type:"string" enum:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceResponse

func (DescribeResourceOutput) GoString

func (s DescribeResourceOutput) GoString() string

GoString returns the string representation

func (DescribeResourceOutput) SDKResponseMetadata

func (s DescribeResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeResourceOutput) String

func (s DescribeResourceOutput) String() string

String returns the string representation

type DescribeResourceRequest

type DescribeResourceRequest struct {
	*aws.Request
	Input *DescribeResourceInput
	Copy  func(*DescribeResourceInput) DescribeResourceRequest
}

DescribeResourceRequest is a API request type for the DescribeResource API operation.

func (DescribeResourceRequest) Send

Send marshals and sends the DescribeResource API request.

type DescribeUserInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserRequest

func (DescribeUserInput) GoString

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (DescribeUserInput) String

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate

func (s *DescribeUserInput) Validate() error

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

type DescribeUserOutput

type DescribeUserOutput struct {

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

	// 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" timestampFormat:"unix"`

	// 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 Amazon WorkMail).
	State EntityState `type:"string" enum:"true"`

	// 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 Amazon WorkMail organizations rely on different directory types,
	// administrators can distinguish between a user that is not registered to Amazon
	// WorkMail (is disabled and has a user role) and the administrative users of
	// the directory. The values are USER, RESOURCE, and SYSTEM_USER.
	UserRole UserRole `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserResponse

func (DescribeUserOutput) GoString

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (DescribeUserOutput) SDKResponseMetadata

func (s DescribeUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeUserOutput) String

func (s DescribeUserOutput) String() string

String returns the string representation

type DescribeUserRequest

type DescribeUserRequest struct {
	*aws.Request
	Input *DescribeUserInput
	Copy  func(*DescribeUserInput) DescribeUserRequest
}

DescribeUserRequest is a API request type for the DescribeUser API operation.

func (DescribeUserRequest) Send

Send marshals and sends the DescribeUser API request.

type DisassociateDelegateFromResourceInput

type DisassociateDelegateFromResourceInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceRequest

func (DisassociateDelegateFromResourceInput) GoString

GoString returns the string representation

func (DisassociateDelegateFromResourceInput) String

String returns the string representation

func (*DisassociateDelegateFromResourceInput) Validate

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

type DisassociateDelegateFromResourceOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceResponse

func (DisassociateDelegateFromResourceOutput) GoString

GoString returns the string representation

func (DisassociateDelegateFromResourceOutput) SDKResponseMetadata

func (s DisassociateDelegateFromResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DisassociateDelegateFromResourceOutput) String

String returns the string representation

type DisassociateDelegateFromResourceRequest

type DisassociateDelegateFromResourceRequest struct {
	*aws.Request
	Input *DisassociateDelegateFromResourceInput
	Copy  func(*DisassociateDelegateFromResourceInput) DisassociateDelegateFromResourceRequest
}

DisassociateDelegateFromResourceRequest is a API request type for the DisassociateDelegateFromResource API operation.

func (DisassociateDelegateFromResourceRequest) Send

Send marshals and sends the DisassociateDelegateFromResource API request.

type DisassociateMemberFromGroupInput

type DisassociateMemberFromGroupInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupRequest

func (DisassociateMemberFromGroupInput) GoString

GoString returns the string representation

func (DisassociateMemberFromGroupInput) String

String returns the string representation

func (*DisassociateMemberFromGroupInput) Validate

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

type DisassociateMemberFromGroupOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupResponse

func (DisassociateMemberFromGroupOutput) GoString

GoString returns the string representation

func (DisassociateMemberFromGroupOutput) SDKResponseMetadata

func (s DisassociateMemberFromGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DisassociateMemberFromGroupOutput) String

String returns the string representation

type DisassociateMemberFromGroupRequest

type DisassociateMemberFromGroupRequest struct {
	*aws.Request
	Input *DisassociateMemberFromGroupInput
	Copy  func(*DisassociateMemberFromGroupInput) DisassociateMemberFromGroupRequest
}

DisassociateMemberFromGroupRequest is a API request type for the DisassociateMemberFromGroup API operation.

func (DisassociateMemberFromGroupRequest) Send

Send marshals and sends the DisassociateMemberFromGroup API request.

type EntityState

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

Enum values for EntityState

func (EntityState) MarshalValue added in v0.3.0

func (enum EntityState) MarshalValue() (string, error)

func (EntityState) MarshalValueBuf added in v0.3.0

func (enum EntityState) MarshalValueBuf(b []byte) ([]byte, error)

type Group

type Group struct {

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

	// 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" timestampFormat:"unix"`

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

The representation of an Amazon WorkMail group. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Group

func (Group) GoString

func (s Group) GoString() string

GoString returns the string representation

func (Group) String

func (s Group) String() string

String returns the string representation

type ListAliasesInput

type ListAliasesInput struct {

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

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesRequest

func (ListAliasesInput) GoString

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (ListAliasesInput) String

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate

func (s *ListAliasesInput) Validate() error

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

type ListAliasesOutput

type ListAliasesOutput struct {

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

	// The token to use to retrieve the next page of results. The value is "null"
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesResponse

func (ListAliasesOutput) GoString

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (ListAliasesOutput) SDKResponseMetadata

func (s ListAliasesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListAliasesOutput) String

func (s ListAliasesOutput) String() string

String returns the string representation

type ListAliasesPager added in v0.3.0

type ListAliasesPager struct {
	aws.Pager
}

ListAliasesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListAliasesPager) CurrentPage added in v0.3.0

func (p *ListAliasesPager) CurrentPage() *ListAliasesOutput

type ListAliasesRequest

type ListAliasesRequest struct {
	*aws.Request
	Input *ListAliasesInput
	Copy  func(*ListAliasesInput) ListAliasesRequest
}

ListAliasesRequest is a API request type for the ListAliases API operation.

func (*ListAliasesRequest) Paginate added in v0.3.0

func (p *ListAliasesRequest) Paginate(opts ...aws.Option) ListAliasesPager

Paginate pages iterates over the pages of a ListAliasesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListAliases operation.
		req := client.ListAliasesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListAliasesRequest) Send

Send marshals and sends the ListAliases API request.

type ListGroupMembersInput

type ListGroupMembersInput struct {

	// The identifier for the group to which the members 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersRequest

func (ListGroupMembersInput) GoString

func (s ListGroupMembersInput) GoString() string

GoString returns the string representation

func (ListGroupMembersInput) String

func (s ListGroupMembersInput) String() string

String returns the string representation

func (*ListGroupMembersInput) Validate

func (s *ListGroupMembersInput) Validate() error

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

type ListGroupMembersOutput

type ListGroupMembersOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersResponse

func (ListGroupMembersOutput) GoString

func (s ListGroupMembersOutput) GoString() string

GoString returns the string representation

func (ListGroupMembersOutput) SDKResponseMetadata

func (s ListGroupMembersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListGroupMembersOutput) String

func (s ListGroupMembersOutput) String() string

String returns the string representation

type ListGroupMembersPager added in v0.3.0

type ListGroupMembersPager struct {
	aws.Pager
}

ListGroupMembersPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListGroupMembersPager) CurrentPage added in v0.3.0

type ListGroupMembersRequest

type ListGroupMembersRequest struct {
	*aws.Request
	Input *ListGroupMembersInput
	Copy  func(*ListGroupMembersInput) ListGroupMembersRequest
}

ListGroupMembersRequest is a API request type for the ListGroupMembers API operation.

func (*ListGroupMembersRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a ListGroupMembersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListGroupMembers operation.
		req := client.ListGroupMembersRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListGroupMembersRequest) Send

Send marshals and sends the ListGroupMembers API request.

type ListGroupsInput

type ListGroupsInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsRequest

func (ListGroupsInput) GoString

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (ListGroupsInput) String

func (s ListGroupsInput) String() string

String returns the string representation

func (*ListGroupsInput) Validate

func (s *ListGroupsInput) Validate() error

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

type ListGroupsOutput

type ListGroupsOutput struct {

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

	// The token to use to retrieve the next page of results. The value is "null"
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsResponse

func (ListGroupsOutput) GoString

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (ListGroupsOutput) SDKResponseMetadata

func (s ListGroupsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListGroupsOutput) String

func (s ListGroupsOutput) String() string

String returns the string representation

type ListGroupsPager added in v0.3.0

type ListGroupsPager struct {
	aws.Pager
}

ListGroupsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListGroupsPager) CurrentPage added in v0.3.0

func (p *ListGroupsPager) CurrentPage() *ListGroupsOutput

type ListGroupsRequest

type ListGroupsRequest struct {
	*aws.Request
	Input *ListGroupsInput
	Copy  func(*ListGroupsInput) ListGroupsRequest
}

ListGroupsRequest is a API request type for the ListGroups API operation.

func (*ListGroupsRequest) Paginate added in v0.3.0

func (p *ListGroupsRequest) Paginate(opts ...aws.Option) ListGroupsPager

Paginate pages iterates over the pages of a ListGroupsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListGroups operation.
		req := client.ListGroupsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListGroupsRequest) Send

Send marshals and sends the ListGroups API request.

type ListOrganizationsInput

type ListOrganizationsInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsRequest

func (ListOrganizationsInput) GoString

func (s ListOrganizationsInput) GoString() string

GoString returns the string representation

func (ListOrganizationsInput) String

func (s ListOrganizationsInput) String() string

String returns the string representation

func (*ListOrganizationsInput) Validate

func (s *ListOrganizationsInput) Validate() error

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

type ListOrganizationsOutput

type ListOrganizationsOutput struct {

	// The token to use to retrieve the next page of results. The value is "null"
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsResponse

func (ListOrganizationsOutput) GoString

func (s ListOrganizationsOutput) GoString() string

GoString returns the string representation

func (ListOrganizationsOutput) SDKResponseMetadata

func (s ListOrganizationsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListOrganizationsOutput) String

func (s ListOrganizationsOutput) String() string

String returns the string representation

type ListOrganizationsPager added in v0.3.0

type ListOrganizationsPager struct {
	aws.Pager
}

ListOrganizationsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListOrganizationsPager) CurrentPage added in v0.3.0

type ListOrganizationsRequest

type ListOrganizationsRequest struct {
	*aws.Request
	Input *ListOrganizationsInput
	Copy  func(*ListOrganizationsInput) ListOrganizationsRequest
}

ListOrganizationsRequest is a API request type for the ListOrganizations API operation.

func (*ListOrganizationsRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a ListOrganizationsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListOrganizations operation.
		req := client.ListOrganizationsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListOrganizationsRequest) Send

Send marshals and sends the ListOrganizations API request.

type ListResourceDelegatesInput

type ListResourceDelegatesInput struct {

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

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

	// The identifier for the organization that contains the resource for which
	// delegates are listed.
	//
	// OrganizationId is a required field
	OrganizationId *string `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesRequest

func (ListResourceDelegatesInput) GoString

func (s ListResourceDelegatesInput) GoString() string

GoString returns the string representation

func (ListResourceDelegatesInput) String

String returns the string representation

func (*ListResourceDelegatesInput) Validate

func (s *ListResourceDelegatesInput) Validate() error

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

type ListResourceDelegatesOutput

type ListResourceDelegatesOutput struct {

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

	// The token used to paginate through the delegates associated with a resource.
	// While results are still available, it has an associated value. When the last
	// page is reached, the token is empty.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesResponse

func (ListResourceDelegatesOutput) GoString

func (s ListResourceDelegatesOutput) GoString() string

GoString returns the string representation

func (ListResourceDelegatesOutput) SDKResponseMetadata

func (s ListResourceDelegatesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListResourceDelegatesOutput) String

String returns the string representation

type ListResourceDelegatesRequest

type ListResourceDelegatesRequest struct {
	*aws.Request
	Input *ListResourceDelegatesInput
	Copy  func(*ListResourceDelegatesInput) ListResourceDelegatesRequest
}

ListResourceDelegatesRequest is a API request type for the ListResourceDelegates API operation.

func (ListResourceDelegatesRequest) Send

Send marshals and sends the ListResourceDelegates API request.

type ListResourcesInput

type ListResourcesInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesRequest

func (ListResourcesInput) GoString

func (s ListResourcesInput) GoString() string

GoString returns the string representation

func (ListResourcesInput) String

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate

func (s *ListResourcesInput) Validate() error

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

type ListResourcesOutput

type ListResourcesOutput struct {

	// The token used to paginate through all the organization's resources. While
	// results are still available, it has an associated value. When the last page
	// is reached, the token is empty.
	NextToken *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesResponse

func (ListResourcesOutput) GoString

func (s ListResourcesOutput) GoString() string

GoString returns the string representation

func (ListResourcesOutput) SDKResponseMetadata

func (s ListResourcesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListResourcesOutput) String

func (s ListResourcesOutput) String() string

String returns the string representation

type ListResourcesPager added in v0.3.0

type ListResourcesPager struct {
	aws.Pager
}

ListResourcesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListResourcesPager) CurrentPage added in v0.3.0

func (p *ListResourcesPager) CurrentPage() *ListResourcesOutput

type ListResourcesRequest

type ListResourcesRequest struct {
	*aws.Request
	Input *ListResourcesInput
	Copy  func(*ListResourcesInput) ListResourcesRequest
}

ListResourcesRequest is a API request type for the ListResources API operation.

func (*ListResourcesRequest) Paginate added in v0.3.0

func (p *ListResourcesRequest) Paginate(opts ...aws.Option) ListResourcesPager

Paginate pages iterates over the pages of a ListResourcesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListResources operation.
		req := client.ListResourcesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListResourcesRequest) Send

Send marshals and sends the ListResources API request.

type ListUsersInput

type ListUsersInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersRequest

func (ListUsersInput) GoString

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (ListUsersInput) String

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput

type ListUsersOutput struct {

	// The token to use to retrieve the next page of results. This value is `null`
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersResponse

func (ListUsersOutput) GoString

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (ListUsersOutput) SDKResponseMetadata

func (s ListUsersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListUsersOutput) String

func (s ListUsersOutput) String() string

String returns the string representation

type ListUsersPager added in v0.3.0

type ListUsersPager struct {
	aws.Pager
}

ListUsersPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListUsersPager) CurrentPage added in v0.3.0

func (p *ListUsersPager) CurrentPage() *ListUsersOutput

type ListUsersRequest

type ListUsersRequest struct {
	*aws.Request
	Input *ListUsersInput
	Copy  func(*ListUsersInput) ListUsersRequest
}

ListUsersRequest is a API request type for the ListUsers API operation.

func (*ListUsersRequest) Paginate added in v0.3.0

func (p *ListUsersRequest) Paginate(opts ...aws.Option) ListUsersPager

Paginate pages iterates over the pages of a ListUsersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListUsers operation.
		req := client.ListUsersRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListUsersRequest) Send

func (r ListUsersRequest) Send() (*ListUsersOutput, error)

Send marshals and sends the ListUsers API request.

type Member

type Member struct {

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

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

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

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

The representation of a group member (user or group). Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Member

func (Member) GoString

func (s Member) GoString() string

GoString returns the string representation

func (Member) String

func (s Member) String() string

String returns the string representation

type MemberType

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

Enum values for MemberType

func (MemberType) MarshalValue added in v0.3.0

func (enum MemberType) MarshalValue() (string, error)

func (MemberType) MarshalValueBuf added in v0.3.0

func (enum MemberType) MarshalValueBuf(b []byte) ([]byte, error)

type OrganizationSummary

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 brief overview associated with an organization. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/OrganizationSummary

func (OrganizationSummary) GoString

func (s OrganizationSummary) GoString() string

GoString returns the string representation

func (OrganizationSummary) String

func (s OrganizationSummary) String() string

String returns the string representation

type RegisterToWorkMailInput

type RegisterToWorkMailInput struct {

	// The email for the entity to be updated.
	//
	// Email is a required field
	Email *string `min:"1" type:"string" required:"true"`

	// The identifier for the entity 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailRequest

func (RegisterToWorkMailInput) GoString

func (s RegisterToWorkMailInput) GoString() string

GoString returns the string representation

func (RegisterToWorkMailInput) String

func (s RegisterToWorkMailInput) String() string

String returns the string representation

func (*RegisterToWorkMailInput) Validate

func (s *RegisterToWorkMailInput) Validate() error

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

type RegisterToWorkMailOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailResponse

func (RegisterToWorkMailOutput) GoString

func (s RegisterToWorkMailOutput) GoString() string

GoString returns the string representation

func (RegisterToWorkMailOutput) SDKResponseMetadata

func (s RegisterToWorkMailOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (RegisterToWorkMailOutput) String

func (s RegisterToWorkMailOutput) String() string

String returns the string representation

type RegisterToWorkMailRequest

type RegisterToWorkMailRequest struct {
	*aws.Request
	Input *RegisterToWorkMailInput
	Copy  func(*RegisterToWorkMailInput) RegisterToWorkMailRequest
}

RegisterToWorkMailRequest is a API request type for the RegisterToWorkMail API operation.

func (RegisterToWorkMailRequest) Send

Send marshals and sends the RegisterToWorkMail API request.

type ResetPasswordInput

type ResetPasswordInput struct {

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

	// The new password for the user.
	//
	// Password is a required field
	Password *string `type:"string" required:"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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordRequest

func (ResetPasswordInput) GoString

func (s ResetPasswordInput) GoString() string

GoString returns the string representation

func (ResetPasswordInput) String

func (s ResetPasswordInput) String() string

String returns the string representation

func (*ResetPasswordInput) Validate

func (s *ResetPasswordInput) Validate() error

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

type ResetPasswordOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordResponse

func (ResetPasswordOutput) GoString

func (s ResetPasswordOutput) GoString() string

GoString returns the string representation

func (ResetPasswordOutput) SDKResponseMetadata

func (s ResetPasswordOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ResetPasswordOutput) String

func (s ResetPasswordOutput) String() string

String returns the string representation

type ResetPasswordRequest

type ResetPasswordRequest struct {
	*aws.Request
	Input *ResetPasswordInput
	Copy  func(*ResetPasswordInput) ResetPasswordRequest
}

ResetPasswordRequest is a API request type for the ResetPassword API operation.

func (ResetPasswordRequest) Send

Send marshals and sends the ResetPassword API request.

type Resource

type Resource struct {

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

	// 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" timestampFormat:"unix"`

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

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

The overview for a resource containing relevant data regarding it. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Resource

func (Resource) GoString

func (s Resource) GoString() string

GoString returns the string representation

func (Resource) String

func (s Resource) String() string

String returns the string representation

type ResourceType

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

Enum values for ResourceType

func (ResourceType) MarshalValue added in v0.3.0

func (enum ResourceType) MarshalValue() (string, error)

func (ResourceType) MarshalValueBuf added in v0.3.0

func (enum ResourceType) MarshalValueBuf(b []byte) ([]byte, error)

type UpdatePrimaryEmailAddressInput

type UpdatePrimaryEmailAddressInput struct {

	// The value of the email to be updated as primary.
	//
	// Email is a required field
	Email *string `min:"1" type:"string" required:"true"`

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressRequest

func (UpdatePrimaryEmailAddressInput) GoString

GoString returns the string representation

func (UpdatePrimaryEmailAddressInput) String

String returns the string representation

func (*UpdatePrimaryEmailAddressInput) Validate

func (s *UpdatePrimaryEmailAddressInput) Validate() error

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

type UpdatePrimaryEmailAddressOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressResponse

func (UpdatePrimaryEmailAddressOutput) GoString

GoString returns the string representation

func (UpdatePrimaryEmailAddressOutput) SDKResponseMetadata

func (s UpdatePrimaryEmailAddressOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdatePrimaryEmailAddressOutput) String

String returns the string representation

type UpdatePrimaryEmailAddressRequest

type UpdatePrimaryEmailAddressRequest struct {
	*aws.Request
	Input *UpdatePrimaryEmailAddressInput
	Copy  func(*UpdatePrimaryEmailAddressInput) UpdatePrimaryEmailAddressRequest
}

UpdatePrimaryEmailAddressRequest is a API request type for the UpdatePrimaryEmailAddress API operation.

func (UpdatePrimaryEmailAddressRequest) Send

Send marshals and sends the UpdatePrimaryEmailAddress API request.

type UpdateResourceInput

type UpdateResourceInput struct {

	// The resource's booking options to be updated.
	BookingOptions *BookingOptions `type:"structure"`

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

	// The identifier associated with the organization for which the resource is
	// updated.
	//
	// OrganizationId is a required field
	OrganizationId *string `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceRequest

func (UpdateResourceInput) GoString

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (UpdateResourceInput) String

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate

func (s *UpdateResourceInput) Validate() error

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

type UpdateResourceOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceResponse

func (UpdateResourceOutput) GoString

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) SDKResponseMetadata

func (s UpdateResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateResourceOutput) String

func (s UpdateResourceOutput) String() string

String returns the string representation

type UpdateResourceRequest

type UpdateResourceRequest struct {
	*aws.Request
	Input *UpdateResourceInput
	Copy  func(*UpdateResourceInput) UpdateResourceRequest
}

UpdateResourceRequest is a API request type for the UpdateResource API operation.

func (UpdateResourceRequest) Send

Send marshals and sends the UpdateResource API request.

type User

type User struct {

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

	// 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" timestampFormat:"unix"`

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

	// The role of the user.
	UserRole UserRole `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The representation of an Amazon WorkMail user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/User

func (User) GoString

func (s User) GoString() string

GoString returns the string representation

func (User) String

func (s User) String() string

String returns the string representation

type UserRole

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

Enum values for UserRole

func (UserRole) MarshalValue added in v0.3.0

func (enum UserRole) MarshalValue() (string, error)

func (UserRole) MarshalValueBuf added in v0.3.0

func (enum UserRole) MarshalValueBuf(b []byte) ([]byte, error)

type WorkMail

type WorkMail struct {
	*aws.Client
}

WorkMail provides the API operation methods for making requests to Amazon WorkMail. See this package's package overview docs for details on the service.

WorkMail methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *WorkMail

New creates a new instance of the WorkMail client with a config.

Example:

// Create a WorkMail client from just a config.
svc := workmail.New(myConfig)

func (*WorkMail) AssociateDelegateToResourceRequest

func (c *WorkMail) AssociateDelegateToResourceRequest(input *AssociateDelegateToResourceInput) AssociateDelegateToResourceRequest

AssociateDelegateToResourceRequest returns a request value for making API operation for Amazon WorkMail.

Adds a member to the resource's set of delegates.

// Example sending a request using the AssociateDelegateToResourceRequest method.
req := client.AssociateDelegateToResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResource

func (*WorkMail) AssociateMemberToGroupRequest

func (c *WorkMail) AssociateMemberToGroupRequest(input *AssociateMemberToGroupInput) AssociateMemberToGroupRequest

AssociateMemberToGroupRequest returns a request value for making API operation for Amazon WorkMail.

Adds a member to the group's set.

// Example sending a request using the AssociateMemberToGroupRequest method.
req := client.AssociateMemberToGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroup

func (*WorkMail) CreateAliasRequest

func (c *WorkMail) CreateAliasRequest(input *CreateAliasInput) CreateAliasRequest

CreateAliasRequest returns a request value for making API operation for Amazon WorkMail.

Adds an alias to the set of a given member of Amazon WorkMail.

// Example sending a request using the CreateAliasRequest method.
req := client.CreateAliasRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*WorkMail) CreateGroupRequest

func (c *WorkMail) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest

CreateGroupRequest returns a request value for making API operation for Amazon WorkMail.

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

// Example sending a request using the CreateGroupRequest method.
req := client.CreateGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroup

func (*WorkMail) CreateResourceRequest

func (c *WorkMail) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest

CreateResourceRequest returns a request value for making API operation for Amazon WorkMail.

Creates a new Amazon WorkMail resource. The available types are equipment and room.

// Example sending a request using the CreateResourceRequest method.
req := client.CreateResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResource

func (*WorkMail) CreateUserRequest

func (c *WorkMail) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making API operation for Amazon WorkMail.

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

// Example sending a request using the CreateUserRequest method.
req := client.CreateUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUser

func (*WorkMail) DeleteAliasRequest

func (c *WorkMail) DeleteAliasRequest(input *DeleteAliasInput) DeleteAliasRequest

DeleteAliasRequest returns a request value for making API operation for Amazon WorkMail.

Remove the alias from a set of aliases for a given user.

// Example sending a request using the DeleteAliasRequest method.
req := client.DeleteAliasRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAlias

func (*WorkMail) DeleteGroupRequest

func (c *WorkMail) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest

DeleteGroupRequest returns a request value for making API operation for Amazon WorkMail.

Deletes a group from Amazon WorkMail.

// Example sending a request using the DeleteGroupRequest method.
req := client.DeleteGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroup

func (*WorkMail) DeleteResourceRequest

func (c *WorkMail) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest

DeleteResourceRequest returns a request value for making API operation for Amazon WorkMail.

Deletes the specified resource.

// Example sending a request using the DeleteResourceRequest method.
req := client.DeleteResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResource

func (*WorkMail) DeleteUserRequest

func (c *WorkMail) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making API operation for Amazon WorkMail.

Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.

// Example sending a request using the DeleteUserRequest method.
req := client.DeleteUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUser

func (*WorkMail) DeregisterFromWorkMailRequest

func (c *WorkMail) DeregisterFromWorkMailRequest(input *DeregisterFromWorkMailInput) DeregisterFromWorkMailRequest

DeregisterFromWorkMailRequest returns a request value for making 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. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

// Example sending a request using the DeregisterFromWorkMailRequest method.
req := client.DeregisterFromWorkMailRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMail

func (*WorkMail) DescribeGroupRequest

func (c *WorkMail) DescribeGroupRequest(input *DescribeGroupInput) DescribeGroupRequest

DescribeGroupRequest returns a request value for making API operation for Amazon WorkMail.

Returns the data available for the group.

// Example sending a request using the DescribeGroupRequest method.
req := client.DescribeGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroup

func (*WorkMail) DescribeOrganizationRequest

func (c *WorkMail) DescribeOrganizationRequest(input *DescribeOrganizationInput) DescribeOrganizationRequest

DescribeOrganizationRequest returns a request value for making API operation for Amazon WorkMail.

Provides more information regarding a given organization based on its identifier.

// Example sending a request using the DescribeOrganizationRequest method.
req := client.DescribeOrganizationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganization

func (*WorkMail) DescribeResourceRequest

func (c *WorkMail) DescribeResourceRequest(input *DescribeResourceInput) DescribeResourceRequest

DescribeResourceRequest returns a request value for making API operation for Amazon WorkMail.

Returns the data available for the resource.

// Example sending a request using the DescribeResourceRequest method.
req := client.DescribeResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResource

func (*WorkMail) DescribeUserRequest

func (c *WorkMail) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest

DescribeUserRequest returns a request value for making API operation for Amazon WorkMail.

Provides information regarding the user.

// Example sending a request using the DescribeUserRequest method.
req := client.DescribeUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUser

func (*WorkMail) DisassociateDelegateFromResourceRequest

func (c *WorkMail) DisassociateDelegateFromResourceRequest(input *DisassociateDelegateFromResourceInput) DisassociateDelegateFromResourceRequest

DisassociateDelegateFromResourceRequest returns a request value for making API operation for Amazon WorkMail.

Removes a member from the resource's set of delegates.

// Example sending a request using the DisassociateDelegateFromResourceRequest method.
req := client.DisassociateDelegateFromResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResource

func (*WorkMail) DisassociateMemberFromGroupRequest

func (c *WorkMail) DisassociateMemberFromGroupRequest(input *DisassociateMemberFromGroupInput) DisassociateMemberFromGroupRequest

DisassociateMemberFromGroupRequest returns a request value for making API operation for Amazon WorkMail.

Removes a member from a group.

// Example sending a request using the DisassociateMemberFromGroupRequest method.
req := client.DisassociateMemberFromGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroup

func (*WorkMail) ListAliasesRequest

func (c *WorkMail) ListAliasesRequest(input *ListAliasesInput) ListAliasesRequest

ListAliasesRequest returns a request value for making API operation for Amazon WorkMail.

Creates a paginated call to list the aliases associated with a given entity.

// Example sending a request using the ListAliasesRequest method.
req := client.ListAliasesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases

func (*WorkMail) ListGroupMembersRequest

func (c *WorkMail) ListGroupMembersRequest(input *ListGroupMembersInput) ListGroupMembersRequest

ListGroupMembersRequest returns a request value for making API operation for Amazon WorkMail.

Returns an overview of the members of a group.

// Example sending a request using the ListGroupMembersRequest method.
req := client.ListGroupMembersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembers

func (*WorkMail) ListGroupsRequest

func (c *WorkMail) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest

ListGroupsRequest returns a request value for making API operation for Amazon WorkMail.

Returns summaries of the organization's groups.

// Example sending a request using the ListGroupsRequest method.
req := client.ListGroupsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroups

func (*WorkMail) ListOrganizationsRequest

func (c *WorkMail) ListOrganizationsRequest(input *ListOrganizationsInput) ListOrganizationsRequest

ListOrganizationsRequest returns a request value for making API operation for Amazon WorkMail.

Returns summaries of the customer's non-deleted organizations.

// Example sending a request using the ListOrganizationsRequest method.
req := client.ListOrganizationsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations

func (*WorkMail) ListResourceDelegatesRequest

func (c *WorkMail) ListResourceDelegatesRequest(input *ListResourceDelegatesInput) ListResourceDelegatesRequest

ListResourceDelegatesRequest returns a request value for making 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.

// Example sending a request using the ListResourceDelegatesRequest method.
req := client.ListResourceDelegatesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegates

func (*WorkMail) ListResourcesRequest

func (c *WorkMail) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest

ListResourcesRequest returns a request value for making API operation for Amazon WorkMail.

Returns summaries of the organization's resources.

// Example sending a request using the ListResourcesRequest method.
req := client.ListResourcesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResources

func (*WorkMail) ListUsersRequest

func (c *WorkMail) ListUsersRequest(input *ListUsersInput) ListUsersRequest

ListUsersRequest returns a request value for making API operation for Amazon WorkMail.

Returns summaries of the organization's users.

// Example sending a request using the ListUsersRequest method.
req := client.ListUsersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsers

func (*WorkMail) RegisterToWorkMailRequest

func (c *WorkMail) RegisterToWorkMailRequest(input *RegisterToWorkMailInput) RegisterToWorkMailRequest

RegisterToWorkMailRequest returns a request value for making API operation for Amazon WorkMail.

Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing (http://aws.amazon.com/workmail/pricing). The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

// Example sending a request using the RegisterToWorkMailRequest method.
req := client.RegisterToWorkMailRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail

func (*WorkMail) ResetPasswordRequest

func (c *WorkMail) ResetPasswordRequest(input *ResetPasswordInput) ResetPasswordRequest

ResetPasswordRequest returns a request value for making API operation for Amazon WorkMail.

Allows the administrator to reset the password for a user.

// Example sending a request using the ResetPasswordRequest method.
req := client.ResetPasswordRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPassword

func (*WorkMail) UpdatePrimaryEmailAddressRequest

func (c *WorkMail) UpdatePrimaryEmailAddressRequest(input *UpdatePrimaryEmailAddressInput) UpdatePrimaryEmailAddressRequest

UpdatePrimaryEmailAddressRequest returns a request value for making API operation for Amazon WorkMail.

Updates the primary email for an entity. 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.

// Example sending a request using the UpdatePrimaryEmailAddressRequest method.
req := client.UpdatePrimaryEmailAddressRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddress

func (*WorkMail) UpdateResourceRequest

func (c *WorkMail) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest

UpdateResourceRequest returns a request value for making API operation for Amazon WorkMail.

Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.

// Example sending a request using the UpdateResourceRequest method.
req := client.UpdateResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResource

Directories

Path Synopsis
Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.
Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.

Jump to

Keyboard shortcuts

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