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

package workmail

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

Index

Constants

const ServiceAPIVersion = "2017-10-01"
const ServiceID = "WorkMail"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AssociateDelegateToResourceInput

type AssociateDelegateToResourceInput struct {
	// The organization under which the resource exists.
	OrganizationId *string
	// The member (user or group) to associate to the resource.
	EntityId *string
	// The resource for which members (users or groups) are associated.
	ResourceId *string
}

type AssociateDelegateToResourceOutput

type AssociateDelegateToResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateMemberToGroupInput

type AssociateMemberToGroupInput struct {
	// The member (user or group) to associate to the group.
	MemberId *string
	// The group to which the member (user or group) is associated.
	GroupId *string
	// The organization under which the group exists.
	OrganizationId *string
}

type AssociateMemberToGroupOutput

type AssociateMemberToGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

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

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored. The WorkMail API is designed for the following scenarios:

Managing users

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateDelegateToResource

func (c *Client) AssociateDelegateToResource(ctx context.Context, params *AssociateDelegateToResourceInput, optFns ...func(*Options)) (*AssociateDelegateToResourceOutput, error)

Adds a member (user or group) to the resource's set of delegates.

func (*Client) AssociateMemberToGroup

func (c *Client) AssociateMemberToGroup(ctx context.Context, params *AssociateMemberToGroupInput, optFns ...func(*Options)) (*AssociateMemberToGroupOutput, error)

Adds a member (user or group) to the group's set.

func (*Client) CreateAlias

func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error)

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

func (*Client) CreateGroup

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

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

func (*Client) CreateResource

func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput, optFns ...func(*Options)) (*CreateResourceOutput, error)

Creates a new Amazon WorkMail resource.

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

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

func (*Client) DeleteAlias

func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error)

Remove one or more specified aliases from a set of aliases for a given user.

func (*Client) DeleteGroup

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group from Amazon WorkMail.

func (*Client) DeleteMailboxPermissions

func (c *Client) DeleteMailboxPermissions(ctx context.Context, params *DeleteMailboxPermissionsInput, optFns ...func(*Options)) (*DeleteMailboxPermissionsOutput, error)

Deletes permissions granted to a member (user or group).

func (*Client) DeleteResource

func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput, optFns ...func(*Options)) (*DeleteResourceOutput, error)

Deletes the specified resource.

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser () action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

func (*Client) DeregisterFromWorkMail

func (c *Client) DeregisterFromWorkMail(ctx context.Context, params *DeregisterFromWorkMailInput, optFns ...func(*Options)) (*DeregisterFromWorkMailOutput, error)

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

func (*Client) DescribeGroup

func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)

Returns the data available for the group.

func (*Client) DescribeOrganization

func (c *Client) DescribeOrganization(ctx context.Context, params *DescribeOrganizationInput, optFns ...func(*Options)) (*DescribeOrganizationOutput, error)

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

func (*Client) DescribeResource

func (c *Client) DescribeResource(ctx context.Context, params *DescribeResourceInput, optFns ...func(*Options)) (*DescribeResourceOutput, error)

Returns the data available for the resource.

func (*Client) DescribeUser

func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)

Provides information regarding the user.

func (*Client) DisassociateDelegateFromResource

func (c *Client) DisassociateDelegateFromResource(ctx context.Context, params *DisassociateDelegateFromResourceInput, optFns ...func(*Options)) (*DisassociateDelegateFromResourceOutput, error)

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

func (*Client) DisassociateMemberFromGroup

func (c *Client) DisassociateMemberFromGroup(ctx context.Context, params *DisassociateMemberFromGroupInput, optFns ...func(*Options)) (*DisassociateMemberFromGroupOutput, error)

Removes a member from a group.

func (*Client) GetMailboxDetails

func (c *Client) GetMailboxDetails(ctx context.Context, params *GetMailboxDetailsInput, optFns ...func(*Options)) (*GetMailboxDetailsOutput, error)

Requests a user's mailbox details for a specified organization and user.

func (*Client) ListAliases

func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error)

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

func (*Client) ListGroupMembers

func (c *Client) ListGroupMembers(ctx context.Context, params *ListGroupMembersInput, optFns ...func(*Options)) (*ListGroupMembersOutput, error)

Returns an overview of the members of a group. Users and groups can be members of a group.

func (*Client) ListGroups

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Returns summaries of the organization's groups.

func (*Client) ListMailboxPermissions

func (c *Client) ListMailboxPermissions(ctx context.Context, params *ListMailboxPermissionsInput, optFns ...func(*Options)) (*ListMailboxPermissionsOutput, error)

Lists the mailbox permissions associated with a user, group, or resource mailbox.

func (*Client) ListOrganizations

func (c *Client) ListOrganizations(ctx context.Context, params *ListOrganizationsInput, optFns ...func(*Options)) (*ListOrganizationsOutput, error)

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

func (*Client) ListResourceDelegates

func (c *Client) ListResourceDelegates(ctx context.Context, params *ListResourceDelegatesInput, optFns ...func(*Options)) (*ListResourceDelegatesOutput, error)

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

func (*Client) ListResources

func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)

Returns summaries of the organization's resources.

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Returns summaries of the organization's users.

func (*Client) PutMailboxPermissions

func (c *Client) PutMailboxPermissions(ctx context.Context, params *PutMailboxPermissionsInput, optFns ...func(*Options)) (*PutMailboxPermissionsOutput, error)

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

func (*Client) RegisterToWorkMail

func (c *Client) RegisterToWorkMail(ctx context.Context, params *RegisterToWorkMailInput, optFns ...func(*Options)) (*RegisterToWorkMailOutput, error)

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

func (*Client) ResetPassword

func (c *Client) ResetPassword(ctx context.Context, params *ResetPasswordInput, optFns ...func(*Options)) (*ResetPasswordOutput, error)

Allows the administrator to reset the password for a user.

func (*Client) UpdateMailboxQuota

func (c *Client) UpdateMailboxQuota(ctx context.Context, params *UpdateMailboxQuotaInput, optFns ...func(*Options)) (*UpdateMailboxQuotaOutput, error)

Updates a user's current mailbox quota for a specified organization and user.

func (*Client) UpdatePrimaryEmailAddress

func (c *Client) UpdatePrimaryEmailAddress(ctx context.Context, params *UpdatePrimaryEmailAddressInput, optFns ...func(*Options)) (*UpdatePrimaryEmailAddressOutput, error)

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

func (*Client) UpdateResource

func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error)

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource () call. The dataset in the request should be the one expected when performing another DescribeResource call.

type CreateAliasInput

type CreateAliasInput struct {
	// The organization under which the member (user or group) exists.
	OrganizationId *string
	// The member (user or group) to which this alias is added.
	EntityId *string
	// The alias to add to the member set.
	Alias *string
}

type CreateAliasOutput

type CreateAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateGroupInput

type CreateGroupInput struct {
	// The name of the group.
	Name *string
	// The organization under which the group is to be created.
	OrganizationId *string
}

type CreateGroupOutput

type CreateGroupOutput struct {
	// The identifier of the group.
	GroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateResourceInput

type CreateResourceInput struct {
	// The type of the new resource. The available types are equipment and room.
	Type types.ResourceType
	// The name of the new resource.
	Name *string
	// The identifier associated with the organization for which the resource is
	// created.
	OrganizationId *string
}

type CreateResourceOutput

type CreateResourceOutput struct {
	// The identifier of the new resource.
	ResourceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserInput

type CreateUserInput struct {
	// The password for the new user.
	Password *string
	// The name for the new user. Simple AD or AD Connector user names have a maximum
	// length of 20. All others have a maximum length of 64.
	Name *string
	// The display name for the new user.
	DisplayName *string
	// The identifier of the organization for which the user is created.
	OrganizationId *string
}

type CreateUserOutput

type CreateUserOutput struct {
	// The identifier for the new user.
	UserId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAliasInput

type DeleteAliasInput struct {
	// The identifier for the organization under which the user exists.
	OrganizationId *string
	// The identifier for the member (user or group) from which to have the aliases
	// removed.
	EntityId *string
	// 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 *string
}

type DeleteAliasOutput

type DeleteAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteGroupInput

type DeleteGroupInput struct {
	// The organization that contains the group.
	OrganizationId *string
	// The identifier of the group to be deleted.
	GroupId *string
}

type DeleteGroupOutput

type DeleteGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMailboxPermissionsInput

type DeleteMailboxPermissionsInput struct {
	// The identifier of the member (user or group)that owns the mailbox.
	EntityId *string
	// The identifier of the organization under which the member (user or group)
	// exists.
	OrganizationId *string
	// The identifier of the member (user or group) for which to delete granted
	// permissions.
	GranteeId *string
}

type DeleteMailboxPermissionsOutput

type DeleteMailboxPermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteResourceInput

type DeleteResourceInput struct {
	// The identifier of the resource to be deleted.
	ResourceId *string
	// The identifier associated with the organization from which the resource is
	// deleted.
	OrganizationId *string
}

type DeleteResourceOutput

type DeleteResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserInput

type DeleteUserInput struct {
	// The identifier of the user to be deleted.
	UserId *string
	// The organization that contains the user to be deleted.
	OrganizationId *string
}

type DeleteUserOutput

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeregisterFromWorkMailInput

type DeregisterFromWorkMailInput struct {
	// The identifier for the organization under which the Amazon WorkMail entity
	// exists.
	OrganizationId *string
	// The identifier for the member (user or group) to be updated.
	EntityId *string
}

type DeregisterFromWorkMailOutput

type DeregisterFromWorkMailOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeGroupInput

type DescribeGroupInput struct {
	// The identifier for the group to be described.
	GroupId *string
	// The identifier for the organization under which the group exists.
	OrganizationId *string
}

type DescribeGroupOutput

type DescribeGroupOutput struct {
	// The identifier of the described group.
	GroupId *string
	// The date and time when a user was deregistered from WorkMail, in UNIX epoch time
	// format.
	DisabledDate *time.Time
	// The name of the described group.
	Name *string
	// The date and time when a user was registered to WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time
	// The email of the described group.
	Email *string
	// The state of the user: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State types.EntityState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeOrganizationInput

type DescribeOrganizationInput struct {
	// The identifier for the organization to be described.
	OrganizationId *string
}

type DescribeOrganizationOutput

type DescribeOrganizationOutput struct {
	// The identifier for the directory associated with an Amazon WorkMail
	// organization.
	DirectoryId *string
	// (Optional) The error message indicating if unexpected behavior was encountered
	// with regards to the organization.
	ErrorMessage *string
	// The default mail domain associated with the organization.
	DefaultMailDomain *string
	// The identifier of an organization.
	OrganizationId *string
	// The date at which the organization became usable in the WorkMail context, in
	// UNIX epoch time format.
	CompletedDate *time.Time
	// The type of directory associated with the WorkMail organization.
	DirectoryType *string
	// The alias for an organization.
	Alias *string
	// The state of an organization.
	State *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeResourceInput

type DescribeResourceInput struct {
	// The identifier associated with the organization for which the resource is
	// described.
	OrganizationId *string
	// The identifier of the resource to be described.
	ResourceId *string
}

type DescribeResourceOutput

type DescribeResourceOutput struct {
	// The type of the described resource.
	Type types.ResourceType
	// The name of the described resource.
	Name *string
	// The date and time when a resource was disabled from WorkMail, in UNIX epoch time
	// format.
	DisabledDate *time.Time
	// The identifier of the described resource.
	ResourceId *string
	// The state of the resource: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State types.EntityState
	// The booking options for the described resource.
	BookingOptions *types.BookingOptions
	// The date and time when a resource was enabled for WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time
	// The email of the described resource.
	Email *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeUserInput

type DescribeUserInput struct {
	// The identifier for the organization under which the user exists.
	OrganizationId *string
	// The identifier for the user to be described.
	UserId *string
}

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
	// The date and time at which the user was enabled for Amazon WorkMail usage, in
	// UNIX epoch time format.
	EnabledDate *time.Time
	// The email of the user.
	Email *string
	// In certain cases, other entities are modeled as users. If interoperability is
	// enabled, resources are imported into Amazon WorkMail as users. Because different
	// WorkMail organizations rely on different directory types, administrators can
	// distinguish between an unregistered user (account is disabled and has a user
	// role) and the directory administrators. The values are USER, RESOURCE, and
	// SYSTEM_USER.
	UserRole types.UserRole
	// The state of a user: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State types.EntityState
	// The name for the user.
	Name *string
	// The identifier for the described user.
	UserId *string
	// The display name of the user.
	DisplayName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateDelegateFromResourceInput

type DisassociateDelegateFromResourceInput struct {
	// The identifier for the organization under which the resource exists.
	OrganizationId *string
	// The identifier of the resource from which delegates' set members are removed.
	ResourceId *string
	// The identifier for the member (user, group) to be removed from the resource's
	// delegates.
	EntityId *string
}

type DisassociateDelegateFromResourceOutput

type DisassociateDelegateFromResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateMemberFromGroupInput

type DisassociateMemberFromGroupInput struct {
	// The identifier for the member to be removed to the group.
	MemberId *string
	// The identifier for the organization under which the group exists.
	OrganizationId *string
	// The identifier for the group from which members are removed.
	GroupId *string
}

type DisassociateMemberFromGroupOutput

type DisassociateMemberFromGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetMailboxDetailsInput

type GetMailboxDetailsInput struct {
	// The identifier for the user whose mailbox details are being requested.
	UserId *string
	// The identifier for the organization that contains the user whose mailbox details
	// are being requested.
	OrganizationId *string
}

type GetMailboxDetailsOutput

type GetMailboxDetailsOutput struct {
	// The current mailbox size, in MB, for the specified user.
	MailboxSize *float64
	// The maximum allowed mailbox size, in MB, for the specified user.
	MailboxQuota *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListAliasesInput

type ListAliasesInput struct {
	// The identifier for the organization under which the entity exists.
	OrganizationId *string
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The identifier for the entity for which to list the aliases.
	EntityId *string
}

type ListAliasesOutput

type ListAliasesOutput struct {
	// The entity's paginated aliases.
	Aliases []*string
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListGroupMembersInput

type ListGroupMembersInput struct {
	// The identifier for the group to which the members (users or groups) are
	// associated.
	GroupId *string
	// The identifier for the organization under which the group exists.
	OrganizationId *string
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
}

type ListGroupMembersOutput

type ListGroupMembersOutput struct {
	// The members associated to the group.
	Members []*types.Member
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListGroupsInput

type ListGroupsInput struct {
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The identifier for the organization under which the groups exist.
	OrganizationId *string
}

type ListGroupsOutput

type ListGroupsOutput struct {
	// The overview of groups for an organization.
	Groups []*types.Group
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListMailboxPermissionsInput

type ListMailboxPermissionsInput struct {
	// The identifier of the organization under which the user, group, or resource
	// exists.
	OrganizationId *string
	// The identifier of the user, group, or resource for which to list mailbox
	// permissions.
	EntityId *string
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// The maximum number of results to return in a single call.
	MaxResults *int32
}

type ListMailboxPermissionsOutput

type ListMailboxPermissionsOutput struct {
	// The token to use to retrieve the next page of results. The value is "null" when
	// there are no more results to return.
	NextToken *string
	// One page of the user, group, or resource mailbox permissions.
	Permissions []*types.Permission

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListOrganizationsInput

type ListOrganizationsInput struct {
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
}

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
	// The overview of owned organizations presented as a list of organization
	// summaries.
	OrganizationSummaries []*types.OrganizationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourceDelegatesInput

type ListResourceDelegatesInput struct {
	// The number of maximum results in a page.
	MaxResults *int32
	// The identifier for the organization that contains the resource for which
	// delegates are listed.
	OrganizationId *string
	// The identifier for the resource whose delegates are listed.
	ResourceId *string
	// The token used to paginate through the delegates associated with a resource.
	NextToken *string
}

type ListResourceDelegatesOutput

type ListResourceDelegatesOutput struct {
	// 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
	// One page of the resource's delegates.
	Delegates []*types.Delegate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourcesInput

type ListResourcesInput struct {
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// The identifier for the organization under which the resources exist.
	OrganizationId *string
}

type ListResourcesOutput

type ListResourcesOutput struct {
	// One page of the organization's resource representation.
	Resources []*types.Resource
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUsersInput

type ListUsersInput struct {
	// The token to use to retrieve the next page of results. The first call does not
	// contain any tokens.
	NextToken *string
	// The maximum number of results to return in a single call.
	MaxResults *int32
	// The identifier for the organization under which the users exist.
	OrganizationId *string
}

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
	// The overview of users for an organization.
	Users []*types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutMailboxPermissionsInput

type PutMailboxPermissionsInput struct {
	// The identifier of the user, group, or resource to which to grant the
	// permissions.
	GranteeId *string
	// The identifier of the user, group, or resource for which to update mailbox
	// permissions.
	EntityId *string
	// The permissions granted to the grantee. SEND_AS allows the grantee to send email
	// as the owner of the mailbox (the grantee is not mentioned on these emails).
	// SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the
	// mailbox (the grantee is not mentioned as the physical sender of these emails).
	// FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other
	// folder-level permissions set on the mailbox.
	PermissionValues []types.PermissionType
	// The identifier of the organization under which the user, group, or resource
	// exists.
	OrganizationId *string
}

type PutMailboxPermissionsOutput

type PutMailboxPermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterToWorkMailInput

type RegisterToWorkMailInput struct {
	// The email for the user, group, or resource to be updated.
	Email *string
	// The identifier for the organization under which the user, group, or resource
	// exists.
	OrganizationId *string
	// The identifier for the user, group, or resource to be updated.
	EntityId *string
}

type RegisterToWorkMailOutput

type RegisterToWorkMailOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResetPasswordInput

type ResetPasswordInput struct {
	// The identifier of the organization that contains the user for which the password
	// is reset.
	OrganizationId *string
	// The identifier of the user for whom the password is reset.
	UserId *string
	// The new password for the user.
	Password *string
}

type ResetPasswordOutput

type ResetPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type UpdateMailboxQuotaInput

type UpdateMailboxQuotaInput struct {
	// The identifer for the user for whom to update the mailbox quota.
	UserId *string
	// The identifier for the organization that contains the user for whom to update
	// the mailbox quota.
	OrganizationId *string
	// The updated mailbox quota, in MB, for the specified user.
	MailboxQuota *int32
}

type UpdateMailboxQuotaOutput

type UpdateMailboxQuotaOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdatePrimaryEmailAddressInput

type UpdatePrimaryEmailAddressInput struct {
	// The organization that contains the user, group, or resource to update.
	OrganizationId *string
	// The value of the email to be updated as primary.
	Email *string
	// The user, group, or resource to update.
	EntityId *string
}

type UpdatePrimaryEmailAddressOutput

type UpdatePrimaryEmailAddressOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateResourceInput

type UpdateResourceInput struct {
	// The identifier of the resource to be updated.
	ResourceId *string
	// The identifier associated with the organization for which the resource is
	// updated.
	OrganizationId *string
	// The name of the resource to be updated.
	Name *string
	// The resource's booking options to be updated.
	BookingOptions *types.BookingOptions
}

type UpdateResourceOutput

type UpdateResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_AssociateDelegateToResource.go api_op_AssociateMemberToGroup.go api_op_CreateAlias.go api_op_CreateGroup.go api_op_CreateResource.go api_op_CreateUser.go api_op_DeleteAlias.go api_op_DeleteGroup.go api_op_DeleteMailboxPermissions.go api_op_DeleteResource.go api_op_DeleteUser.go api_op_DeregisterFromWorkMail.go api_op_DescribeGroup.go api_op_DescribeOrganization.go api_op_DescribeResource.go api_op_DescribeUser.go api_op_DisassociateDelegateFromResource.go api_op_DisassociateMemberFromGroup.go api_op_GetMailboxDetails.go api_op_ListAliases.go api_op_ListGroupMembers.go api_op_ListGroups.go api_op_ListMailboxPermissions.go api_op_ListOrganizations.go api_op_ListResourceDelegates.go api_op_ListResources.go api_op_ListUsers.go api_op_PutMailboxPermissions.go api_op_RegisterToWorkMail.go api_op_ResetPassword.go api_op_UpdateMailboxQuota.go api_op_UpdatePrimaryEmailAddress.go api_op_UpdateResource.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.1.0
Published
Sep 29, 2020
Platform
js/wasm
Imports
26 packages
Last checked
now

Tools for package owners.