workmail

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 29 Imported by: 22

Documentation

Overview

Package workmail provides the API client, operations, and parameter types for Amazon WorkMail.

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

* Listing and describing organizations

* Managing users

* Managing groups

* Managing resources

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

Index

Constants

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

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateDelegateToResourceInput 

type AssociateDelegateToResourceInput struct {

	// The member (user or group) to associate to the resource.
	//
	// This member is required.
	EntityId *string

	// The organization under which the resource exists.
	//
	// This member is required.
	OrganizationId *string

	// The resource for which members (users or groups) are associated.
	//
	// This member is required.
	ResourceId *string
}

type AssociateDelegateToResourceOutput 

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

type AssociateMemberToGroupInput 

type AssociateMemberToGroupInput struct {

	// The group to which the member (user or group) is associated.
	//
	// This member is required.
	GroupId *string

	// The member (user or group) to associate to the group.
	//
	// This member is required.
	MemberId *string

	// The organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string
}

type AssociateMemberToGroupOutput 

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

type CancelMailboxExportJobInput added in v0.29.0 

type CancelMailboxExportJobInput struct {

	// The idempotency token for the client request.
	//
	// This member is required.
	ClientToken *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
}

type CancelMailboxExportJobOutput added in v0.29.0 

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

type Client 

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

Client provides the API client to make operations call for Amazon WorkMail.

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) CancelMailboxExportJob added in v0.29.0 

func (c *Client) CancelMailboxExportJob(ctx context.Context, params *CancelMailboxExportJobInput, optFns ...func(*Options)) (*CancelMailboxExportJobOutput, error)

Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.

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) CreateOrganization added in v0.29.0 

func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error)

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html) in the Amazon WorkMail Administrator Guide. You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) and Choosing the default domain (https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html) in the Amazon WorkMail Administrator Guide. Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.

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) DeleteAccessControlRule added in v0.29.0 

func (c *Client) DeleteAccessControlRule(ctx context.Context, params *DeleteAccessControlRuleInput, optFns ...func(*Options)) (*DeleteAccessControlRuleOutput, error)

Deletes an access control rule for the specified WorkMail organization.

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) DeleteOrganization added in v0.29.0 

func (c *Client) DeleteOrganization(ctx context.Context, params *DeleteOrganizationInput, optFns ...func(*Options)) (*DeleteOrganizationOutput, error)

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html) in the Amazon WorkMail Administrator Guide.

func (*Client) DeleteResource 

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

Deletes the specified resource.

func (*Client) DeleteRetentionPolicy added in v0.29.0 

func (c *Client) DeleteRetentionPolicy(ctx context.Context, params *DeleteRetentionPolicyInput, optFns ...func(*Options)) (*DeleteRetentionPolicyOutput, error)

Deletes the specified retention policy from the specified organization.

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) DescribeMailboxExportJob added in v0.29.0 

func (c *Client) DescribeMailboxExportJob(ctx context.Context, params *DescribeMailboxExportJobInput, optFns ...func(*Options)) (*DescribeMailboxExportJobOutput, error)

Describes the current status of a mailbox export job.

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) GetAccessControlEffect added in v0.29.0 

func (c *Client) GetAccessControlEffect(ctx context.Context, params *GetAccessControlEffectInput, optFns ...func(*Options)) (*GetAccessControlEffectOutput, error)

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

func (*Client) GetDefaultRetentionPolicy added in v0.29.0 

func (c *Client) GetDefaultRetentionPolicy(ctx context.Context, params *GetDefaultRetentionPolicyInput, optFns ...func(*Options)) (*GetDefaultRetentionPolicyOutput, error)

Gets the default retention policy details for the specified organization.

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) ListAccessControlRules added in v0.29.0 

func (c *Client) ListAccessControlRules(ctx context.Context, params *ListAccessControlRulesInput, optFns ...func(*Options)) (*ListAccessControlRulesOutput, error)

Lists the access control rules for the specified organization.

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) ListMailboxExportJobs added in v0.29.0 

func (c *Client) ListMailboxExportJobs(ctx context.Context, params *ListMailboxExportJobsInput, optFns ...func(*Options)) (*ListMailboxExportJobsOutput, error)

Lists the mailbox export jobs started for the specified organization within the last seven days.

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 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) ListTagsForResource added in v0.29.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags applied to an Amazon WorkMail organization resource.

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) PutAccessControlRule added in v0.29.0 

func (c *Client) PutAccessControlRule(ctx context.Context, params *PutAccessControlRuleInput, optFns ...func(*Options)) (*PutAccessControlRuleOutput, error)

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

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) PutRetentionPolicy added in v0.29.0 

func (c *Client) PutRetentionPolicy(ctx context.Context, params *PutRetentionPolicyInput, optFns ...func(*Options)) (*PutRetentionPolicyOutput, error)

Puts a retention policy to the specified organization.

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) StartMailboxExportJob added in v0.29.0 

func (c *Client) StartMailboxExportJob(ctx context.Context, params *StartMailboxExportJobInput, optFns ...func(*Options)) (*StartMailboxExportJobOutput, error)

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content (https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html) in the Amazon WorkMail Administrator Guide.

func (*Client) TagResource added in v0.29.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Applies the specified tags to the specified Amazon WorkMail organization resource.

func (*Client) UntagResource added in v0.29.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untags the specified tags from the specified Amazon WorkMail organization resource.

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 alias to add to the member set.
	//
	// This member is required.
	Alias *string

	// The member (user or group) to which this alias is added.
	//
	// This member is required.
	EntityId *string

	// The organization under which the member (user or group) exists.
	//
	// This member is required.
	OrganizationId *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.
	//
	// This member is required.
	Name *string

	// The organization under which the group is to be created.
	//
	// This member is required.
	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 CreateOrganizationInput added in v0.29.0 

type CreateOrganizationInput struct {

	// The organization alias.
	//
	// This member is required.
	Alias *string

	// The idempotency token associated with the request.
	ClientToken *string

	// The AWS Directory Service directory ID.
	DirectoryId *string

	// The email domains to associate with the organization.
	Domains []types.Domain

	// When true, allows organization interoperability between Amazon WorkMail and
	// Microsoft Exchange. Can only be set to true if an AD Connector directory ID is
	// included in the request.
	EnableInteroperability bool

	// The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.
	KmsKeyArn *string
}

type CreateOrganizationOutput added in v0.29.0 

type CreateOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string

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

type CreateResourceInput 

type CreateResourceInput struct {

	// The name of the new resource.
	//
	// This member is required.
	Name *string

	// The identifier associated with the organization for which the resource is
	// created.
	//
	// This member is required.
	OrganizationId *string

	// The type of the new resource. The available types are equipment and room.
	//
	// This member is required.
	Type types.ResourceType
}

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 display name for the new user.
	//
	// This member is required.
	DisplayName *string

	// The name for the new user. WorkMail directory user names have a maximum length
	// of 64. All others have a maximum length of 20.
	//
	// This member is required.
	Name *string

	// The identifier of the organization for which the user is created.
	//
	// This member is required.
	OrganizationId *string

	// The password for the new user.
	//
	// This member is required.
	Password *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 DeleteAccessControlRuleInput added in v0.29.0 

type DeleteAccessControlRuleInput struct {

	// The name of the access control rule.
	//
	// This member is required.
	Name *string

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string
}

type DeleteAccessControlRuleOutput added in v0.29.0 

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

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).
	//
	// This member is required.
	Alias *string

	// The identifier for the member (user or group) from which to have the aliases
	// removed.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the user exists.
	//
	// This member is required.
	OrganizationId *string
}

type DeleteAliasOutput 

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

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The identifier of the group to be deleted.
	//
	// This member is required.
	GroupId *string

	// The organization that contains the group.
	//
	// This member is required.
	OrganizationId *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.
	//
	// This member is required.
	EntityId *string

	// The identifier of the member (user or group) for which to delete granted
	// permissions.
	//
	// This member is required.
	GranteeId *string

	// The identifier of the organization under which the member (user or group)
	// exists.
	//
	// This member is required.
	OrganizationId *string
}

type DeleteMailboxPermissionsOutput 

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

type DeleteOrganizationInput added in v0.29.0 

type DeleteOrganizationInput struct {

	// If true, deletes the AWS Directory Service directory associated with the
	// organization.
	//
	// This member is required.
	DeleteDirectory bool

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string

	// The idempotency token associated with the request.
	ClientToken *string
}

type DeleteOrganizationOutput added in v0.29.0 

type DeleteOrganizationOutput struct {

	// The organization ID.
	OrganizationId *string

	// The state of the organization.
	State *string

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

type DeleteResourceInput 

type DeleteResourceInput struct {

	// The identifier associated with the organization from which the resource is
	// deleted.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be deleted.
	//
	// This member is required.
	ResourceId *string
}

type DeleteResourceOutput 

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

type DeleteRetentionPolicyInput added in v0.29.0 

type DeleteRetentionPolicyInput struct {

	// The retention policy ID.
	//
	// This member is required.
	Id *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
}

type DeleteRetentionPolicyOutput added in v0.29.0 

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

type DeleteUserInput 

type DeleteUserInput struct {

	// The organization that contains the user to be deleted.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the user to be deleted.
	//
	// This member is required.
	UserId *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 member (user or group) to be updated.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the Amazon WorkMail entity
	// exists.
	//
	// This member is required.
	OrganizationId *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.
	//
	// This member is required.
	GroupId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *string
}

type DescribeGroupOutput 

type DescribeGroupOutput struct {

	// The date and time when a user was deregistered from WorkMail, in UNIX epoch time
	// format.
	DisabledDate *time.Time

	// The email of the described group.
	Email *string

	// The date and time when a user was registered to WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time

	// The identifier of the described group.
	GroupId *string

	// The name of the described group.
	Name *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 DescribeMailboxExportJobInput added in v0.29.0 

type DescribeMailboxExportJobInput struct {

	// The mailbox export job ID.
	//
	// This member is required.
	JobId *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
}

type DescribeMailboxExportJobOutput added in v0.29.0 

type DescribeMailboxExportJobOutput struct {

	// The mailbox export job description.
	Description *string

	// The mailbox export job end timestamp.
	EndTime *time.Time

	// The identifier of the user or resource associated with the mailbox.
	EntityId *string

	// Error information for failed mailbox export jobs.
	ErrorInfo *string

	// The estimated progress of the mailbox export job, in percentage points.
	EstimatedProgress int32

	// The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS
	// KMS) key that encrypts the exported mailbox content.
	KmsKeyArn *string

	// The ARN of the AWS Identity and Access Management (IAM) role that grants write
	// permission to the Amazon Simple Storage Service (Amazon S3) bucket.
	RoleArn *string

	// The name of the S3 bucket.
	S3BucketName *string

	// The path to the S3 bucket and file that the mailbox export job is exporting to.
	S3Path *string

	// The S3 bucket prefix.
	S3Prefix *string

	// The mailbox export job start timestamp.
	StartTime *time.Time

	// The state of the mailbox export job.
	State types.MailboxExportJobState

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

type DescribeOrganizationInput 

type DescribeOrganizationInput struct {

	// The identifier for the organization to be described.
	//
	// This member is required.
	OrganizationId *string
}

type DescribeOrganizationOutput 

type DescribeOrganizationOutput struct {

	// The Amazon Resource Name (ARN) of the organization.
	ARN *string

	// The alias for an organization.
	Alias *string

	// The date at which the organization became usable in the WorkMail context, in
	// UNIX epoch time format.
	CompletedDate *time.Time

	// The default mail domain associated with the organization.
	DefaultMailDomain *string

	// The identifier for the directory associated with an Amazon WorkMail
	// organization.
	DirectoryId *string

	// The type of directory associated with the WorkMail organization.
	DirectoryType *string

	// (Optional) The error message indicating if unexpected behavior was encountered
	// with regards to the organization.
	ErrorMessage *string

	// The identifier of an organization.
	OrganizationId *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.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be described.
	//
	// This member is required.
	ResourceId *string
}

type DescribeResourceOutput 

type DescribeResourceOutput struct {

	// The booking options for the described resource.
	BookingOptions *types.BookingOptions

	// The date and time when a resource was disabled from WorkMail, in UNIX epoch time
	// format.
	DisabledDate *time.Time

	// The email of the described resource.
	Email *string

	// The date and time when a resource was enabled for WorkMail, in UNIX epoch time
	// format.
	EnabledDate *time.Time

	// The name of the described resource.
	Name *string

	// The identifier of the described resource.
	ResourceId *string

	// The state of the resource: enabled (registered to Amazon WorkMail), disabled
	// (deregistered or never registered to WorkMail), or deleted.
	State types.EntityState

	// The type of the described resource.
	Type types.ResourceType

	// 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.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the user to be described.
	//
	// This member is required.
	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 display name of the user.
	DisplayName *string

	// The email of the user.
	Email *string

	// The date and time at which the user was enabled for Amazon WorkMail usage, in
	// UNIX epoch time format.
	EnabledDate *time.Time

	// The name for the user.
	Name *string

	// The state of a user: enabled (registered to Amazon WorkMail) or disabled
	// (deregistered or never registered to WorkMail).
	State types.EntityState

	// The identifier for the described user.
	UserId *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

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

type DisassociateDelegateFromResourceInput 

type DisassociateDelegateFromResourceInput struct {

	// The identifier for the member (user, group) to be removed from the resource's
	// delegates.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the resource exists.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource from which delegates' set members are removed.
	//
	// This member is required.
	ResourceId *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 group from which members are removed.
	//
	// This member is required.
	GroupId *string

	// The identifier for the member to be removed to the group.
	//
	// This member is required.
	MemberId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	OrganizationId *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 EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAccessControlEffectInput added in v0.29.0 

type GetAccessControlEffectInput struct {

	// The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS,
	// IMAP, SMTP, WindowsOutlook, and WebMail.
	//
	// This member is required.
	Action *string

	// The IPv4 address.
	//
	// This member is required.
	IpAddress *string

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type GetAccessControlEffectOutput added in v0.29.0 

type GetAccessControlEffectOutput struct {

	// The rule effect.
	Effect types.AccessControlRuleEffect

	// The rules that match the given parameters, resulting in an effect.
	MatchedRules []string

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

type GetDefaultRetentionPolicyInput added in v0.29.0 

type GetDefaultRetentionPolicyInput struct {

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string
}

type GetDefaultRetentionPolicyOutput added in v0.29.0 

type GetDefaultRetentionPolicyOutput struct {

	// The retention policy description.
	Description *string

	// The retention policy folder configurations.
	FolderConfigurations []types.FolderConfiguration

	// The retention policy ID.
	Id *string

	// The retention policy name.
	Name *string

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

type GetMailboxDetailsInput 

type GetMailboxDetailsInput struct {

	// The identifier for the organization that contains the user whose mailbox details
	// are being requested.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the user whose mailbox details are being requested.
	//
	// This member is required.
	UserId *string
}

type GetMailboxDetailsOutput 

type GetMailboxDetailsOutput struct {

	// The maximum allowed mailbox size, in MB, for the specified user.
	MailboxQuota *int32

	// The current mailbox size, in MB, for the specified user.
	MailboxSize float64

	// 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, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider added in v0.29.0 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccessControlRulesInput added in v0.29.0 

type ListAccessControlRulesInput struct {

	// The identifier for the organization.
	//
	// This member is required.
	OrganizationId *string
}

type ListAccessControlRulesOutput added in v0.29.0 

type ListAccessControlRulesOutput struct {

	// The access control rules.
	Rules []types.AccessControlRule

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

type ListAliasesAPIClient added in v0.30.0 

type ListAliasesAPIClient interface {
	ListAliases(context.Context, *ListAliasesInput, ...func(*Options)) (*ListAliasesOutput, error)
}

ListAliasesAPIClient is a client that implements the ListAliases operation.

type ListAliasesInput 

type ListAliasesInput struct {

	// The identifier for the entity for which to list the aliases.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the entity exists.
	//
	// This member is required.
	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 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 ListAliasesPaginator added in v0.30.0 

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

ListAliasesPaginator is a paginator for ListAliases

func NewListAliasesPaginator added in v0.30.0 

func NewListAliasesPaginator(client ListAliasesAPIClient, params *ListAliasesInput, optFns ...func(*ListAliasesPaginatorOptions)) *ListAliasesPaginator

NewListAliasesPaginator returns a new ListAliasesPaginator

func (*ListAliasesPaginator) HasMorePages added in v0.30.0 

func (p *ListAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAliasesPaginator) NextPage added in v0.30.0 

func (p *ListAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAliasesOutput, error)

NextPage retrieves the next ListAliases page.

type ListAliasesPaginatorOptions added in v0.30.0 

type ListAliasesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAliasesPaginatorOptions is the paginator options for ListAliases

type ListGroupMembersAPIClient added in v0.30.0 

type ListGroupMembersAPIClient interface {
	ListGroupMembers(context.Context, *ListGroupMembersInput, ...func(*Options)) (*ListGroupMembersOutput, error)
}

ListGroupMembersAPIClient is a client that implements the ListGroupMembers operation.

type ListGroupMembersInput 

type ListGroupMembersInput struct {

	// The identifier for the group to which the members (users or groups) are
	// associated.
	//
	// This member is required.
	GroupId *string

	// The identifier for the organization under which the group exists.
	//
	// This member is required.
	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 ListGroupMembersPaginator added in v0.30.0 

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

ListGroupMembersPaginator is a paginator for ListGroupMembers

func NewListGroupMembersPaginator added in v0.30.0 

func NewListGroupMembersPaginator(client ListGroupMembersAPIClient, params *ListGroupMembersInput, optFns ...func(*ListGroupMembersPaginatorOptions)) *ListGroupMembersPaginator

NewListGroupMembersPaginator returns a new ListGroupMembersPaginator

func (*ListGroupMembersPaginator) HasMorePages added in v0.30.0 

func (p *ListGroupMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupMembersPaginator) NextPage added in v0.30.0 

func (p *ListGroupMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupMembersOutput, error)

NextPage retrieves the next ListGroupMembers page.

type ListGroupMembersPaginatorOptions added in v0.30.0 

type ListGroupMembersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGroupMembersPaginatorOptions is the paginator options for ListGroupMembers

type ListGroupsAPIClient added in v0.30.0 

type ListGroupsAPIClient interface {
	ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
}

ListGroupsAPIClient is a client that implements the ListGroups operation.

type ListGroupsInput 

type ListGroupsInput struct {

	// The identifier for the organization under which the groups exist.
	//
	// This member is required.
	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 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 ListGroupsPaginator added in v0.30.0 

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

ListGroupsPaginator is a paginator for ListGroups

func NewListGroupsPaginator added in v0.30.0 

func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator

NewListGroupsPaginator returns a new ListGroupsPaginator

func (*ListGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupsPaginator) NextPage added in v0.30.0 

func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)

NextPage retrieves the next ListGroups page.

type ListGroupsPaginatorOptions added in v0.30.0 

type ListGroupsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGroupsPaginatorOptions is the paginator options for ListGroups

type ListMailboxExportJobsAPIClient added in v0.30.0 

type ListMailboxExportJobsAPIClient interface {
	ListMailboxExportJobs(context.Context, *ListMailboxExportJobsInput, ...func(*Options)) (*ListMailboxExportJobsOutput, error)
}

ListMailboxExportJobsAPIClient is a client that implements the ListMailboxExportJobs operation.

type ListMailboxExportJobsInput added in v0.29.0 

type ListMailboxExportJobsInput struct {

	// The organization ID.
	//
	// This member is required.
	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.
	NextToken *string
}

type ListMailboxExportJobsOutput added in v0.29.0 

type ListMailboxExportJobsOutput struct {

	// The mailbox export job details.
	Jobs []types.MailboxExportJob

	// The token to use to retrieve the next page of results.
	NextToken *string

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

type ListMailboxExportJobsPaginator added in v0.30.0 

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

ListMailboxExportJobsPaginator is a paginator for ListMailboxExportJobs

func NewListMailboxExportJobsPaginator added in v0.30.0 

func NewListMailboxExportJobsPaginator(client ListMailboxExportJobsAPIClient, params *ListMailboxExportJobsInput, optFns ...func(*ListMailboxExportJobsPaginatorOptions)) *ListMailboxExportJobsPaginator

NewListMailboxExportJobsPaginator returns a new ListMailboxExportJobsPaginator

func (*ListMailboxExportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListMailboxExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMailboxExportJobsPaginator) NextPage added in v0.30.0 

func (p *ListMailboxExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMailboxExportJobsOutput, error)

NextPage retrieves the next ListMailboxExportJobs page.

type ListMailboxExportJobsPaginatorOptions added in v0.30.0 

type ListMailboxExportJobsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMailboxExportJobsPaginatorOptions is the paginator options for ListMailboxExportJobs

type ListMailboxPermissionsAPIClient added in v0.30.0 

type ListMailboxPermissionsAPIClient interface {
	ListMailboxPermissions(context.Context, *ListMailboxPermissionsInput, ...func(*Options)) (*ListMailboxPermissionsOutput, error)
}

ListMailboxPermissionsAPIClient is a client that implements the ListMailboxPermissions operation.

type ListMailboxPermissionsInput 

type ListMailboxPermissionsInput struct {

	// The identifier of the user, group, or resource for which to list mailbox
	// permissions.
	//
	// This member is required.
	EntityId *string

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	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 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 ListMailboxPermissionsPaginator added in v0.30.0 

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

ListMailboxPermissionsPaginator is a paginator for ListMailboxPermissions

func NewListMailboxPermissionsPaginator added in v0.30.0 

func NewListMailboxPermissionsPaginator(client ListMailboxPermissionsAPIClient, params *ListMailboxPermissionsInput, optFns ...func(*ListMailboxPermissionsPaginatorOptions)) *ListMailboxPermissionsPaginator

NewListMailboxPermissionsPaginator returns a new ListMailboxPermissionsPaginator

func (*ListMailboxPermissionsPaginator) HasMorePages added in v0.30.0 

func (p *ListMailboxPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMailboxPermissionsPaginator) NextPage added in v0.30.0 

func (p *ListMailboxPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMailboxPermissionsOutput, error)

NextPage retrieves the next ListMailboxPermissions page.

type ListMailboxPermissionsPaginatorOptions added in v0.30.0 

type ListMailboxPermissionsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMailboxPermissionsPaginatorOptions is the paginator options for ListMailboxPermissions

type ListOrganizationsAPIClient added in v0.30.0 

type ListOrganizationsAPIClient interface {
	ListOrganizations(context.Context, *ListOrganizationsInput, ...func(*Options)) (*ListOrganizationsOutput, error)
}

ListOrganizationsAPIClient is a client that implements the ListOrganizations operation.

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 ListOrganizationsPaginator added in v0.30.0 

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

ListOrganizationsPaginator is a paginator for ListOrganizations

func NewListOrganizationsPaginator added in v0.30.0 

func NewListOrganizationsPaginator(client ListOrganizationsAPIClient, params *ListOrganizationsInput, optFns ...func(*ListOrganizationsPaginatorOptions)) *ListOrganizationsPaginator

NewListOrganizationsPaginator returns a new ListOrganizationsPaginator

func (*ListOrganizationsPaginator) HasMorePages added in v0.30.0 

func (p *ListOrganizationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrganizationsPaginator) NextPage added in v0.30.0 

func (p *ListOrganizationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationsOutput, error)

NextPage retrieves the next ListOrganizations page.

type ListOrganizationsPaginatorOptions added in v0.30.0 

type ListOrganizationsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListOrganizationsPaginatorOptions is the paginator options for ListOrganizations

type ListResourceDelegatesAPIClient added in v0.30.0 

type ListResourceDelegatesAPIClient interface {
	ListResourceDelegates(context.Context, *ListResourceDelegatesInput, ...func(*Options)) (*ListResourceDelegatesOutput, error)
}

ListResourceDelegatesAPIClient is a client that implements the ListResourceDelegates operation.

type ListResourceDelegatesInput 

type ListResourceDelegatesInput struct {

	// The identifier for the organization that contains the resource for which
	// delegates are listed.
	//
	// This member is required.
	OrganizationId *string

	// The identifier for the resource whose delegates are listed.
	//
	// This member is required.
	ResourceId *string

	// The number of maximum results in a page.
	MaxResults *int32

	// The token used to paginate through the delegates associated with a resource.
	NextToken *string
}

type ListResourceDelegatesOutput 

type ListResourceDelegatesOutput struct {

	// One page of the resource's delegates.
	Delegates []types.Delegate

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

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

type ListResourceDelegatesPaginator added in v0.30.0 

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

ListResourceDelegatesPaginator is a paginator for ListResourceDelegates

func NewListResourceDelegatesPaginator added in v0.30.0 

func NewListResourceDelegatesPaginator(client ListResourceDelegatesAPIClient, params *ListResourceDelegatesInput, optFns ...func(*ListResourceDelegatesPaginatorOptions)) *ListResourceDelegatesPaginator

NewListResourceDelegatesPaginator returns a new ListResourceDelegatesPaginator

func (*ListResourceDelegatesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourceDelegatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceDelegatesPaginator) NextPage added in v0.30.0 

func (p *ListResourceDelegatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceDelegatesOutput, error)

NextPage retrieves the next ListResourceDelegates page.

type ListResourceDelegatesPaginatorOptions added in v0.30.0 

type ListResourceDelegatesPaginatorOptions struct {
	// The number of maximum results in a page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourceDelegatesPaginatorOptions is the paginator options for ListResourceDelegates

type ListResourcesAPIClient added in v0.30.0 

type ListResourcesAPIClient interface {
	ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}

ListResourcesAPIClient is a client that implements the ListResources operation.

type ListResourcesInput 

type ListResourcesInput struct {

	// The identifier for the organization under which the resources exist.
	//
	// This member is required.
	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 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

	// One page of the organization's resource representation.
	Resources []types.Resource

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

type ListResourcesPaginator added in v0.30.0 

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

ListResourcesPaginator is a paginator for ListResources

func NewListResourcesPaginator added in v0.30.0 

func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator

NewListResourcesPaginator returns a new ListResourcesPaginator

func (*ListResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesPaginator) NextPage added in v0.30.0 

func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)

NextPage retrieves the next ListResources page.

type ListResourcesPaginatorOptions added in v0.30.0 

type ListResourcesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcesPaginatorOptions is the paginator options for ListResources

type ListTagsForResourceInput added in v0.29.0 

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string
}

type ListTagsForResourceOutput added in v0.29.0 

type ListTagsForResourceOutput struct {

	// A list of tag key-value pairs.
	Tags []types.Tag

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

type ListUsersAPIClient added in v0.30.0 

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersInput 

type ListUsersInput struct {

	// The identifier for the organization under which the users exist.
	//
	// This member is required.
	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 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 ListUsersPaginator added in v0.30.0 

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator added in v0.30.0 

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages added in v0.30.0 

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage added in v0.30.0 

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions added in v0.30.0 

type ListUsersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUsersPaginatorOptions is the paginator options for ListUsers

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

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

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

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

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

type PutAccessControlRuleInput added in v0.29.0 

type PutAccessControlRuleInput struct {

	// The rule description.
	//
	// This member is required.
	Description *string

	// The rule effect.
	//
	// This member is required.
	Effect types.AccessControlRuleEffect

	// The rule name.
	//
	// This member is required.
	Name *string

	// The identifier of the organization.
	//
	// This member is required.
	OrganizationId *string

	// Access protocol actions to include in the rule. Valid values include ActiveSync,
	// AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
	Actions []string

	// IPv4 CIDR ranges to include in the rule.
	IpRanges []string

	// Access protocol actions to exclude from the rule. Valid values include
	// ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
	NotActions []string

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

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

	// User IDs to include in the rule.
	UserIds []string
}

type PutAccessControlRuleOutput added in v0.29.0 

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

type PutMailboxPermissionsInput 

type PutMailboxPermissionsInput struct {

	// The identifier of the user, group, or resource for which to update mailbox
	// permissions.
	//
	// This member is required.
	EntityId *string

	// The identifier of the user, group, or resource to which to grant the
	// permissions.
	//
	// This member is required.
	GranteeId *string

	// The identifier of the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	OrganizationId *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.
	//
	// This member is required.
	PermissionValues []types.PermissionType
}

type PutMailboxPermissionsOutput 

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

type PutRetentionPolicyInput added in v0.29.0 

type PutRetentionPolicyInput struct {

	// The retention policy folder configurations.
	//
	// This member is required.
	FolderConfigurations []types.FolderConfiguration

	// The retention policy name.
	//
	// This member is required.
	Name *string

	// The organization ID.
	//
	// This member is required.
	OrganizationId *string

	// The retention policy description.
	Description *string

	// The retention policy ID.
	Id *string
}

type PutRetentionPolicyOutput added in v0.29.0 

type PutRetentionPolicyOutput 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.
	//
	// This member is required.
	Email *string

	// The identifier for the user, group, or resource to be updated.
	//
	// This member is required.
	EntityId *string

	// The identifier for the organization under which the user, group, or resource
	// exists.
	//
	// This member is required.
	OrganizationId *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.
	//
	// This member is required.
	OrganizationId *string

	// The new password for the user.
	//
	// This member is required.
	Password *string

	// The identifier of the user for whom the password is reset.
	//
	// This member is required.
	UserId *string
}

type ResetPasswordOutput 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartMailboxExportJobInput added in v0.29.0 

type StartMailboxExportJobInput struct {

	// The idempotency token for the client request.
	//
	// This member is required.
	ClientToken *string

	// The identifier of the user or resource associated with the mailbox.
	//
	// This member is required.
	EntityId *string

	// The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS
	// KMS) key that encrypts the exported mailbox content.
	//
	// This member is required.
	KmsKeyArn *string

	// The identifier associated with the organization.
	//
	// This member is required.
	OrganizationId *string

	// The ARN of the AWS Identity and Access Management (IAM) role that grants write
	// permission to the S3 bucket.
	//
	// This member is required.
	RoleArn *string

	// The name of the S3 bucket.
	//
	// This member is required.
	S3BucketName *string

	// The S3 bucket prefix.
	//
	// This member is required.
	S3Prefix *string

	// The mailbox export job description.
	Description *string
}

type StartMailboxExportJobOutput added in v0.29.0 

type StartMailboxExportJobOutput struct {

	// The job ID.
	JobId *string

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

type TagResourceInput added in v0.29.0 

type TagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag key-value pairs.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput added in v0.29.0 

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

type UntagResourceInput added in v0.29.0 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput added in v0.29.0 

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

type UpdateMailboxQuotaInput 

type UpdateMailboxQuotaInput struct {

	// The updated mailbox quota, in MB, for the specified user.
	//
	// This member is required.
	MailboxQuota *int32

	// The identifier for the organization that contains the user for whom to update
	// the mailbox quota.
	//
	// This member is required.
	OrganizationId *string

	// The identifer for the user for whom to update the mailbox quota.
	//
	// This member is required.
	UserId *string
}

type UpdateMailboxQuotaOutput 

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

type UpdatePrimaryEmailAddressInput 

type UpdatePrimaryEmailAddressInput struct {

	// The value of the email to be updated as primary.
	//
	// This member is required.
	Email *string

	// The user, group, or resource to update.
	//
	// This member is required.
	EntityId *string

	// The organization that contains the user, group, or resource to update.
	//
	// This member is required.
	OrganizationId *string
}

type UpdatePrimaryEmailAddressOutput 

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

type UpdateResourceInput 

type UpdateResourceInput struct {

	// The identifier associated with the organization for which the resource is
	// updated.
	//
	// This member is required.
	OrganizationId *string

	// The identifier of the resource to be updated.
	//
	// This member is required.
	ResourceId *string

	// The resource's booking options to be updated.
	BookingOptions *types.BookingOptions

	// The name of the resource to be updated.
	Name *string
}

type UpdateResourceOutput 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.