Documentation ¶
Overview ¶
Package workmail provides the client and types for making API requests to Amazon WorkMail.
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
See https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01 for more information on this service.
See workmail package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workmail/
Using the Client ¶
To use Amazon WorkMail with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon WorkMail client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workmail/#New
Index ¶
- Constants
- type AssociateDelegateToResourceInput
- type AssociateDelegateToResourceOutput
- type AssociateDelegateToResourceRequest
- type AssociateDelegateToResourceResponse
- type AssociateMemberToGroupInput
- type AssociateMemberToGroupOutput
- type AssociateMemberToGroupRequest
- type AssociateMemberToGroupResponse
- type BookingOptions
- type Client
- func (c *Client) AssociateDelegateToResourceRequest(input *AssociateDelegateToResourceInput) AssociateDelegateToResourceRequest
- func (c *Client) AssociateMemberToGroupRequest(input *AssociateMemberToGroupInput) AssociateMemberToGroupRequest
- func (c *Client) CreateAliasRequest(input *CreateAliasInput) CreateAliasRequest
- func (c *Client) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
- func (c *Client) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest
- func (c *Client) CreateUserRequest(input *CreateUserInput) CreateUserRequest
- func (c *Client) DeleteAliasRequest(input *DeleteAliasInput) DeleteAliasRequest
- func (c *Client) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
- func (c *Client) DeleteMailboxPermissionsRequest(input *DeleteMailboxPermissionsInput) DeleteMailboxPermissionsRequest
- func (c *Client) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest
- func (c *Client) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
- func (c *Client) DeregisterFromWorkMailRequest(input *DeregisterFromWorkMailInput) DeregisterFromWorkMailRequest
- func (c *Client) DescribeGroupRequest(input *DescribeGroupInput) DescribeGroupRequest
- func (c *Client) DescribeOrganizationRequest(input *DescribeOrganizationInput) DescribeOrganizationRequest
- func (c *Client) DescribeResourceRequest(input *DescribeResourceInput) DescribeResourceRequest
- func (c *Client) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest
- func (c *Client) DisassociateDelegateFromResourceRequest(input *DisassociateDelegateFromResourceInput) DisassociateDelegateFromResourceRequest
- func (c *Client) DisassociateMemberFromGroupRequest(input *DisassociateMemberFromGroupInput) DisassociateMemberFromGroupRequest
- func (c *Client) GetMailboxDetailsRequest(input *GetMailboxDetailsInput) GetMailboxDetailsRequest
- func (c *Client) ListAliasesRequest(input *ListAliasesInput) ListAliasesRequest
- func (c *Client) ListGroupMembersRequest(input *ListGroupMembersInput) ListGroupMembersRequest
- func (c *Client) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
- func (c *Client) ListMailboxPermissionsRequest(input *ListMailboxPermissionsInput) ListMailboxPermissionsRequest
- func (c *Client) ListOrganizationsRequest(input *ListOrganizationsInput) ListOrganizationsRequest
- func (c *Client) ListResourceDelegatesRequest(input *ListResourceDelegatesInput) ListResourceDelegatesRequest
- func (c *Client) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest
- func (c *Client) ListUsersRequest(input *ListUsersInput) ListUsersRequest
- func (c *Client) PutMailboxPermissionsRequest(input *PutMailboxPermissionsInput) PutMailboxPermissionsRequest
- func (c *Client) RegisterToWorkMailRequest(input *RegisterToWorkMailInput) RegisterToWorkMailRequest
- func (c *Client) ResetPasswordRequest(input *ResetPasswordInput) ResetPasswordRequest
- func (c *Client) UpdateMailboxQuotaRequest(input *UpdateMailboxQuotaInput) UpdateMailboxQuotaRequest
- func (c *Client) UpdatePrimaryEmailAddressRequest(input *UpdatePrimaryEmailAddressInput) UpdatePrimaryEmailAddressRequest
- func (c *Client) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest
- type CreateAliasInput
- type CreateAliasOutput
- type CreateAliasRequest
- type CreateAliasResponse
- type CreateGroupInput
- type CreateGroupOutput
- type CreateGroupRequest
- type CreateGroupResponse
- type CreateResourceInput
- type CreateResourceOutput
- type CreateResourceRequest
- type CreateResourceResponse
- type CreateUserInput
- type CreateUserOutput
- type CreateUserRequest
- type CreateUserResponse
- type Delegate
- type DeleteAliasInput
- type DeleteAliasOutput
- type DeleteAliasRequest
- type DeleteAliasResponse
- type DeleteGroupInput
- type DeleteGroupOutput
- type DeleteGroupRequest
- type DeleteGroupResponse
- type DeleteMailboxPermissionsInput
- type DeleteMailboxPermissionsOutput
- type DeleteMailboxPermissionsRequest
- type DeleteMailboxPermissionsResponse
- type DeleteResourceInput
- type DeleteResourceOutput
- type DeleteResourceRequest
- type DeleteResourceResponse
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteUserRequest
- type DeleteUserResponse
- type DeregisterFromWorkMailInput
- type DeregisterFromWorkMailOutput
- type DeregisterFromWorkMailRequest
- type DeregisterFromWorkMailResponse
- type DescribeGroupInput
- type DescribeGroupOutput
- type DescribeGroupRequest
- type DescribeGroupResponse
- type DescribeOrganizationInput
- type DescribeOrganizationOutput
- type DescribeOrganizationRequest
- type DescribeOrganizationResponse
- type DescribeResourceInput
- type DescribeResourceOutput
- type DescribeResourceRequest
- type DescribeResourceResponse
- type DescribeUserInput
- type DescribeUserOutput
- type DescribeUserRequest
- type DescribeUserResponse
- type DisassociateDelegateFromResourceInput
- type DisassociateDelegateFromResourceOutput
- type DisassociateDelegateFromResourceRequest
- type DisassociateDelegateFromResourceResponse
- type DisassociateMemberFromGroupInput
- type DisassociateMemberFromGroupOutput
- type DisassociateMemberFromGroupRequest
- type DisassociateMemberFromGroupResponse
- type EntityState
- type GetMailboxDetailsInput
- type GetMailboxDetailsOutput
- type GetMailboxDetailsRequest
- type GetMailboxDetailsResponse
- type Group
- type ListAliasesInput
- type ListAliasesOutput
- type ListAliasesPaginator
- type ListAliasesRequest
- type ListAliasesResponse
- type ListGroupMembersInput
- type ListGroupMembersOutput
- type ListGroupMembersPaginator
- type ListGroupMembersRequest
- type ListGroupMembersResponse
- type ListGroupsInput
- type ListGroupsOutput
- type ListGroupsPaginator
- type ListGroupsRequest
- type ListGroupsResponse
- type ListMailboxPermissionsInput
- type ListMailboxPermissionsOutput
- type ListMailboxPermissionsPaginator
- type ListMailboxPermissionsRequest
- type ListMailboxPermissionsResponse
- type ListOrganizationsInput
- type ListOrganizationsOutput
- type ListOrganizationsPaginator
- type ListOrganizationsRequest
- type ListOrganizationsResponse
- type ListResourceDelegatesInput
- type ListResourceDelegatesOutput
- type ListResourceDelegatesPaginator
- type ListResourceDelegatesRequest
- type ListResourceDelegatesResponse
- type ListResourcesInput
- type ListResourcesOutput
- type ListResourcesPaginator
- type ListResourcesRequest
- type ListResourcesResponse
- type ListUsersInput
- type ListUsersOutput
- type ListUsersPaginator
- type ListUsersRequest
- type ListUsersResponse
- type Member
- type MemberType
- type OrganizationSummary
- type Permission
- type PermissionType
- type PutMailboxPermissionsInput
- type PutMailboxPermissionsOutput
- type PutMailboxPermissionsRequest
- type PutMailboxPermissionsResponse
- type RegisterToWorkMailInput
- type RegisterToWorkMailOutput
- type RegisterToWorkMailRequest
- type RegisterToWorkMailResponse
- type ResetPasswordInput
- type ResetPasswordOutput
- type ResetPasswordRequest
- type ResetPasswordResponse
- type Resource
- type ResourceType
- type UpdateMailboxQuotaInput
- type UpdateMailboxQuotaOutput
- type UpdateMailboxQuotaRequest
- type UpdateMailboxQuotaResponse
- type UpdatePrimaryEmailAddressInput
- type UpdatePrimaryEmailAddressOutput
- type UpdatePrimaryEmailAddressRequest
- type UpdatePrimaryEmailAddressResponse
- type UpdateResourceInput
- type UpdateResourceOutput
- type UpdateResourceRequest
- type UpdateResourceResponse
- type User
- type UserRole
Constants ¶
const ( ServiceName = "Amazon WorkMail" // Service's name ServiceID = "WorkMail" // Service's identifier EndpointsID = "workmail" // Service's Endpoint identifier )
const ( // ErrCodeDirectoryServiceAuthenticationFailedException for service response error code // "DirectoryServiceAuthenticationFailedException". // // The directory service doesn't recognize the credentials supplied by WorkMail. ErrCodeDirectoryServiceAuthenticationFailedException = "DirectoryServiceAuthenticationFailedException" // "DirectoryUnavailableException". // // The directory on which you are trying to perform operations isn't available. ErrCodeDirectoryUnavailableException = "DirectoryUnavailableException" // ErrCodeEmailAddressInUseException for service response error code // "EmailAddressInUseException". // // The email address that you're trying to assign is already created for a different // user, group, or resource. ErrCodeEmailAddressInUseException = "EmailAddressInUseException" // ErrCodeEntityAlreadyRegisteredException for service response error code // "EntityAlreadyRegisteredException". // // The user, group, or resource that you're trying to register is already registered. ErrCodeEntityAlreadyRegisteredException = "EntityAlreadyRegisteredException" // ErrCodeEntityNotFoundException for service response error code // "EntityNotFoundException". // // The identifier supplied for the user, group, or resource does not exist in // your organization. ErrCodeEntityNotFoundException = "EntityNotFoundException" // ErrCodeEntityStateException for service response error code // "EntityStateException". // // You are performing an operation on a user, group, or resource that isn't // in the expected state, such as trying to delete an active user. ErrCodeEntityStateException = "EntityStateException" // ErrCodeInvalidConfigurationException for service response error code // "InvalidConfigurationException". // // The configuration for a resource isn't valid. A resource must either be able // to auto-respond to requests or have at least one delegate associated that // can do so on its behalf. ErrCodeInvalidConfigurationException = "InvalidConfigurationException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // One or more of the input parameters don't match the service's restrictions. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeInvalidPasswordException for service response error code // "InvalidPasswordException". // // The supplied password doesn't match the minimum security constraints, such // as length or use of special characters. ErrCodeInvalidPasswordException = "InvalidPasswordException" // ErrCodeMailDomainNotFoundException for service response error code // "MailDomainNotFoundException". // // For an email or alias to be created in Amazon WorkMail, the included domain // must be defined in the organization. ErrCodeMailDomainNotFoundException = "MailDomainNotFoundException" // ErrCodeMailDomainStateException for service response error code // "MailDomainStateException". // // After a domain has been added to the organization, it must be verified. The // domain is not yet verified. ErrCodeMailDomainStateException = "MailDomainStateException" // ErrCodeNameAvailabilityException for service response error code // "NameAvailabilityException". // // The user, group, or resource name isn't unique in Amazon WorkMail. ErrCodeNameAvailabilityException = "NameAvailabilityException" // ErrCodeOrganizationNotFoundException for service response error code // "OrganizationNotFoundException". // // An operation received a valid organization identifier that either doesn't // belong or exist in the system. ErrCodeOrganizationNotFoundException = "OrganizationNotFoundException" // ErrCodeOrganizationStateException for service response error code // "OrganizationStateException". // // The organization must have a valid state (Active or Synchronizing) to perform // certain operations on the organization or its members. ErrCodeOrganizationStateException = "OrganizationStateException" // ErrCodeReservedNameException for service response error code // "ReservedNameException". // // This user, group, or resource name is not allowed in Amazon WorkMail. ErrCodeReservedNameException = "ReservedNameException" // ErrCodeUnsupportedOperationException for service response error code // "UnsupportedOperationException". // // You can't perform a write operation against a read-only directory. ErrCodeUnsupportedOperationException = "UnsupportedOperationException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociateDelegateToResourceInput ¶
type AssociateDelegateToResourceInput struct { // The member (user or group) to associate to the resource. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The organization under which the resource exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The resource for which members (users or groups) are associated. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceRequest
func (AssociateDelegateToResourceInput) String ¶
func (s AssociateDelegateToResourceInput) String() string
String returns the string representation
func (*AssociateDelegateToResourceInput) Validate ¶
func (s *AssociateDelegateToResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateDelegateToResourceOutput ¶
type AssociateDelegateToResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResourceResponse
func (AssociateDelegateToResourceOutput) String ¶
func (s AssociateDelegateToResourceOutput) String() string
String returns the string representation
type AssociateDelegateToResourceRequest ¶
type AssociateDelegateToResourceRequest struct { *aws.Request Input *AssociateDelegateToResourceInput Copy func(*AssociateDelegateToResourceInput) AssociateDelegateToResourceRequest }
AssociateDelegateToResourceRequest is the request type for the AssociateDelegateToResource API operation.
func (AssociateDelegateToResourceRequest) Send ¶
func (r AssociateDelegateToResourceRequest) Send(ctx context.Context) (*AssociateDelegateToResourceResponse, error)
Send marshals and sends the AssociateDelegateToResource API request.
type AssociateDelegateToResourceResponse ¶ added in v0.9.0
type AssociateDelegateToResourceResponse struct { *AssociateDelegateToResourceOutput // contains filtered or unexported fields }
AssociateDelegateToResourceResponse is the response type for the AssociateDelegateToResource API operation.
func (*AssociateDelegateToResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AssociateDelegateToResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AssociateDelegateToResource request.
type AssociateMemberToGroupInput ¶
type AssociateMemberToGroupInput struct { // The group to which the member (user or group) is associated. // // GroupId is a required field GroupId *string `min:"12" type:"string" required:"true"` // The member (user or group) to associate to the group. // // MemberId is a required field MemberId *string `min:"12" type:"string" required:"true"` // The organization under which the group exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupRequest
func (AssociateMemberToGroupInput) String ¶
func (s AssociateMemberToGroupInput) String() string
String returns the string representation
func (*AssociateMemberToGroupInput) Validate ¶
func (s *AssociateMemberToGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateMemberToGroupOutput ¶
type AssociateMemberToGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroupResponse
func (AssociateMemberToGroupOutput) String ¶
func (s AssociateMemberToGroupOutput) String() string
String returns the string representation
type AssociateMemberToGroupRequest ¶
type AssociateMemberToGroupRequest struct { *aws.Request Input *AssociateMemberToGroupInput Copy func(*AssociateMemberToGroupInput) AssociateMemberToGroupRequest }
AssociateMemberToGroupRequest is the request type for the AssociateMemberToGroup API operation.
func (AssociateMemberToGroupRequest) Send ¶
func (r AssociateMemberToGroupRequest) Send(ctx context.Context) (*AssociateMemberToGroupResponse, error)
Send marshals and sends the AssociateMemberToGroup API request.
type AssociateMemberToGroupResponse ¶ added in v0.9.0
type AssociateMemberToGroupResponse struct { *AssociateMemberToGroupOutput // contains filtered or unexported fields }
AssociateMemberToGroupResponse is the response type for the AssociateMemberToGroup API operation.
func (*AssociateMemberToGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AssociateMemberToGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AssociateMemberToGroup request.
type BookingOptions ¶
type BookingOptions struct { // The resource's ability to automatically reply to requests. If disabled, delegates // must be associated to the resource. AutoAcceptRequests *bool `type:"boolean"` // The resource's ability to automatically decline any conflicting requests. AutoDeclineConflictingRequests *bool `type:"boolean"` // The resource's ability to automatically decline any recurring requests. AutoDeclineRecurringRequests *bool `type:"boolean"` // contains filtered or unexported fields }
At least one delegate must be associated to the resource to disable automatic replies from the resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/BookingOptions
func (BookingOptions) String ¶
func (s BookingOptions) String() string
String returns the string representation
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amazon WorkMail. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := workmail.New(myConfig)
func (*Client) AssociateDelegateToResourceRequest ¶ added in v0.9.0
func (c *Client) AssociateDelegateToResourceRequest(input *AssociateDelegateToResourceInput) AssociateDelegateToResourceRequest
AssociateDelegateToResourceRequest returns a request value for making API operation for Amazon WorkMail.
Adds a member (user or group) to the resource's set of delegates.
// Example sending a request using AssociateDelegateToResourceRequest. req := client.AssociateDelegateToResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResource
func (*Client) AssociateMemberToGroupRequest ¶ added in v0.9.0
func (c *Client) AssociateMemberToGroupRequest(input *AssociateMemberToGroupInput) AssociateMemberToGroupRequest
AssociateMemberToGroupRequest returns a request value for making API operation for Amazon WorkMail.
Adds a member (user or group) to the group's set.
// Example sending a request using AssociateMemberToGroupRequest. req := client.AssociateMemberToGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroup
func (*Client) CreateAliasRequest ¶ added in v0.9.0
func (c *Client) CreateAliasRequest(input *CreateAliasInput) CreateAliasRequest
CreateAliasRequest returns a request value for making API operation for Amazon WorkMail.
Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
// Example sending a request using CreateAliasRequest. req := client.CreateAliasRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAlias
func (*Client) CreateGroupRequest ¶ added in v0.9.0
func (c *Client) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
CreateGroupRequest returns a request value for making API operation for Amazon WorkMail.
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
// Example sending a request using CreateGroupRequest. req := client.CreateGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroup
func (*Client) CreateResourceRequest ¶ added in v0.9.0
func (c *Client) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest
CreateResourceRequest returns a request value for making API operation for Amazon WorkMail.
Creates a new Amazon WorkMail resource.
// Example sending a request using CreateResourceRequest. req := client.CreateResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResource
func (*Client) CreateUserRequest ¶ added in v0.9.0
func (c *Client) CreateUserRequest(input *CreateUserInput) CreateUserRequest
CreateUserRequest returns a request value for making API operation for Amazon WorkMail.
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
// Example sending a request using CreateUserRequest. req := client.CreateUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUser
func (*Client) DeleteAliasRequest ¶ added in v0.9.0
func (c *Client) DeleteAliasRequest(input *DeleteAliasInput) DeleteAliasRequest
DeleteAliasRequest returns a request value for making API operation for Amazon WorkMail.
Remove one or more specified aliases from a set of aliases for a given user.
// Example sending a request using DeleteAliasRequest. req := client.DeleteAliasRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAlias
func (*Client) DeleteGroupRequest ¶ added in v0.9.0
func (c *Client) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
DeleteGroupRequest returns a request value for making API operation for Amazon WorkMail.
Deletes a group from Amazon WorkMail.
// Example sending a request using DeleteGroupRequest. req := client.DeleteGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroup
func (*Client) DeleteMailboxPermissionsRequest ¶ added in v0.9.0
func (c *Client) DeleteMailboxPermissionsRequest(input *DeleteMailboxPermissionsInput) DeleteMailboxPermissionsRequest
DeleteMailboxPermissionsRequest returns a request value for making API operation for Amazon WorkMail.
Deletes permissions granted to a member (user or group).
// Example sending a request using DeleteMailboxPermissionsRequest. req := client.DeleteMailboxPermissionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissions
func (*Client) DeleteResourceRequest ¶ added in v0.9.0
func (c *Client) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest
DeleteResourceRequest returns a request value for making API operation for Amazon WorkMail.
Deletes the specified resource.
// Example sending a request using DeleteResourceRequest. req := client.DeleteResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResource
func (*Client) DeleteUserRequest ¶ added in v0.9.0
func (c *Client) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
DeleteUserRequest returns a request value for making API operation for Amazon WorkMail.
Deletes a user from Amazon WorkMail and all subsequent systems. 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.
// Example sending a request using DeleteUserRequest. req := client.DeleteUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUser
func (*Client) DeregisterFromWorkMailRequest ¶ added in v0.9.0
func (c *Client) DeregisterFromWorkMailRequest(input *DeregisterFromWorkMailInput) DeregisterFromWorkMailRequest
DeregisterFromWorkMailRequest returns a request value for making API operation for Amazon WorkMail.
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
// Example sending a request using DeregisterFromWorkMailRequest. req := client.DeregisterFromWorkMailRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMail
func (*Client) DescribeGroupRequest ¶ added in v0.9.0
func (c *Client) DescribeGroupRequest(input *DescribeGroupInput) DescribeGroupRequest
DescribeGroupRequest returns a request value for making API operation for Amazon WorkMail.
Returns the data available for the group.
// Example sending a request using DescribeGroupRequest. req := client.DescribeGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroup
func (*Client) DescribeOrganizationRequest ¶ added in v0.9.0
func (c *Client) DescribeOrganizationRequest(input *DescribeOrganizationInput) DescribeOrganizationRequest
DescribeOrganizationRequest returns a request value for making API operation for Amazon WorkMail.
Provides more information regarding a given organization based on its identifier.
// Example sending a request using DescribeOrganizationRequest. req := client.DescribeOrganizationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganization
func (*Client) DescribeResourceRequest ¶ added in v0.9.0
func (c *Client) DescribeResourceRequest(input *DescribeResourceInput) DescribeResourceRequest
DescribeResourceRequest returns a request value for making API operation for Amazon WorkMail.
Returns the data available for the resource.
// Example sending a request using DescribeResourceRequest. req := client.DescribeResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResource
func (*Client) DescribeUserRequest ¶ added in v0.9.0
func (c *Client) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest
DescribeUserRequest returns a request value for making API operation for Amazon WorkMail.
Provides information regarding the user.
// Example sending a request using DescribeUserRequest. req := client.DescribeUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUser
func (*Client) DisassociateDelegateFromResourceRequest ¶ added in v0.9.0
func (c *Client) DisassociateDelegateFromResourceRequest(input *DisassociateDelegateFromResourceInput) DisassociateDelegateFromResourceRequest
DisassociateDelegateFromResourceRequest returns a request value for making API operation for Amazon WorkMail.
Removes a member from the resource's set of delegates.
// Example sending a request using DisassociateDelegateFromResourceRequest. req := client.DisassociateDelegateFromResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResource
func (*Client) DisassociateMemberFromGroupRequest ¶ added in v0.9.0
func (c *Client) DisassociateMemberFromGroupRequest(input *DisassociateMemberFromGroupInput) DisassociateMemberFromGroupRequest
DisassociateMemberFromGroupRequest returns a request value for making API operation for Amazon WorkMail.
Removes a member from a group.
// Example sending a request using DisassociateMemberFromGroupRequest. req := client.DisassociateMemberFromGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroup
func (*Client) GetMailboxDetailsRequest ¶ added in v0.9.0
func (c *Client) GetMailboxDetailsRequest(input *GetMailboxDetailsInput) GetMailboxDetailsRequest
GetMailboxDetailsRequest returns a request value for making API operation for Amazon WorkMail.
Requests a user's mailbox details for a specified organization and user.
// Example sending a request using GetMailboxDetailsRequest. req := client.GetMailboxDetailsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetails
func (*Client) ListAliasesRequest ¶ added in v0.9.0
func (c *Client) ListAliasesRequest(input *ListAliasesInput) ListAliasesRequest
ListAliasesRequest returns a request value for making API operation for Amazon WorkMail.
Creates a paginated call to list the aliases associated with a given entity.
// Example sending a request using ListAliasesRequest. req := client.ListAliasesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases
func (*Client) ListGroupMembersRequest ¶ added in v0.9.0
func (c *Client) ListGroupMembersRequest(input *ListGroupMembersInput) ListGroupMembersRequest
ListGroupMembersRequest returns a request value for making API operation for Amazon WorkMail.
Returns an overview of the members of a group. Users and groups can be members of a group.
// Example sending a request using ListGroupMembersRequest. req := client.ListGroupMembersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembers
func (*Client) ListGroupsRequest ¶ added in v0.9.0
func (c *Client) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
ListGroupsRequest returns a request value for making API operation for Amazon WorkMail.
Returns summaries of the organization's groups.
// Example sending a request using ListGroupsRequest. req := client.ListGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroups
func (*Client) ListMailboxPermissionsRequest ¶ added in v0.9.0
func (c *Client) ListMailboxPermissionsRequest(input *ListMailboxPermissionsInput) ListMailboxPermissionsRequest
ListMailboxPermissionsRequest returns a request value for making API operation for Amazon WorkMail.
Lists the mailbox permissions associated with a user, group, or resource mailbox.
// Example sending a request using ListMailboxPermissionsRequest. req := client.ListMailboxPermissionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissions
func (*Client) ListOrganizationsRequest ¶ added in v0.9.0
func (c *Client) ListOrganizationsRequest(input *ListOrganizationsInput) ListOrganizationsRequest
ListOrganizationsRequest returns a request value for making API operation for Amazon WorkMail.
Returns summaries of the customer's non-deleted organizations.
// Example sending a request using ListOrganizationsRequest. req := client.ListOrganizationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations
func (*Client) ListResourceDelegatesRequest ¶ added in v0.9.0
func (c *Client) ListResourceDelegatesRequest(input *ListResourceDelegatesInput) ListResourceDelegatesRequest
ListResourceDelegatesRequest returns a request value for making API operation for Amazon WorkMail.
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
// Example sending a request using ListResourceDelegatesRequest. req := client.ListResourceDelegatesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegates
func (*Client) ListResourcesRequest ¶ added in v0.9.0
func (c *Client) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest
ListResourcesRequest returns a request value for making API operation for Amazon WorkMail.
Returns summaries of the organization's resources.
// Example sending a request using ListResourcesRequest. req := client.ListResourcesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResources
func (*Client) ListUsersRequest ¶ added in v0.9.0
func (c *Client) ListUsersRequest(input *ListUsersInput) ListUsersRequest
ListUsersRequest returns a request value for making API operation for Amazon WorkMail.
Returns summaries of the organization's users.
// Example sending a request using ListUsersRequest. req := client.ListUsersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsers
func (*Client) PutMailboxPermissionsRequest ¶ added in v0.9.0
func (c *Client) PutMailboxPermissionsRequest(input *PutMailboxPermissionsInput) PutMailboxPermissionsRequest
PutMailboxPermissionsRequest returns a request value for making API operation for Amazon WorkMail.
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
// Example sending a request using PutMailboxPermissionsRequest. req := client.PutMailboxPermissionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissions
func (*Client) RegisterToWorkMailRequest ¶ added in v0.9.0
func (c *Client) RegisterToWorkMailRequest(input *RegisterToWorkMailInput) RegisterToWorkMailRequest
RegisterToWorkMailRequest returns a request value for making API operation for Amazon WorkMail.
Registers an existing and disabled user, group, or resource 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.
// Example sending a request using RegisterToWorkMailRequest. req := client.RegisterToWorkMailRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail
func (*Client) ResetPasswordRequest ¶ added in v0.9.0
func (c *Client) ResetPasswordRequest(input *ResetPasswordInput) ResetPasswordRequest
ResetPasswordRequest returns a request value for making API operation for Amazon WorkMail.
Allows the administrator to reset the password for a user.
// Example sending a request using ResetPasswordRequest. req := client.ResetPasswordRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPassword
func (*Client) UpdateMailboxQuotaRequest ¶ added in v0.9.0
func (c *Client) UpdateMailboxQuotaRequest(input *UpdateMailboxQuotaInput) UpdateMailboxQuotaRequest
UpdateMailboxQuotaRequest returns a request value for making API operation for Amazon WorkMail.
Updates a user's current mailbox quota for a specified organization and user.
// Example sending a request using UpdateMailboxQuotaRequest. req := client.UpdateMailboxQuotaRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuota
func (*Client) UpdatePrimaryEmailAddressRequest ¶ added in v0.9.0
func (c *Client) UpdatePrimaryEmailAddressRequest(input *UpdatePrimaryEmailAddressInput) UpdatePrimaryEmailAddressRequest
UpdatePrimaryEmailAddressRequest returns a request value for making API operation for Amazon WorkMail.
Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
// Example sending a request using UpdatePrimaryEmailAddressRequest. req := client.UpdatePrimaryEmailAddressRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddress
func (*Client) UpdateResourceRequest ¶ added in v0.9.0
func (c *Client) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest
UpdateResourceRequest returns a request value for making API operation for Amazon WorkMail.
Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
// Example sending a request using UpdateResourceRequest. req := client.UpdateResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResource
type CreateAliasInput ¶
type CreateAliasInput struct { // The alias to add to the member set. // // Alias is a required field Alias *string `min:"1" type:"string" required:"true"` // The member (user or group) to which this alias is added. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The organization under which the member (user or group) exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasRequest
func (CreateAliasInput) String ¶
func (s CreateAliasInput) String() string
String returns the string representation
func (*CreateAliasInput) Validate ¶
func (s *CreateAliasInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAliasOutput ¶
type CreateAliasOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAliasResponse
func (CreateAliasOutput) String ¶
func (s CreateAliasOutput) String() string
String returns the string representation
type CreateAliasRequest ¶
type CreateAliasRequest struct { *aws.Request Input *CreateAliasInput Copy func(*CreateAliasInput) CreateAliasRequest }
CreateAliasRequest is the request type for the CreateAlias API operation.
func (CreateAliasRequest) Send ¶
func (r CreateAliasRequest) Send(ctx context.Context) (*CreateAliasResponse, error)
Send marshals and sends the CreateAlias API request.
type CreateAliasResponse ¶ added in v0.9.0
type CreateAliasResponse struct { *CreateAliasOutput // contains filtered or unexported fields }
CreateAliasResponse is the response type for the CreateAlias API operation.
func (*CreateAliasResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateAliasResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateAlias request.
type CreateGroupInput ¶
type CreateGroupInput struct { // The name of the group. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The organization under which the group is to be created. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupRequest
func (CreateGroupInput) String ¶
func (s CreateGroupInput) String() string
String returns the string representation
func (*CreateGroupInput) Validate ¶
func (s *CreateGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGroupOutput ¶
type CreateGroupOutput struct { // The identifier of the group. GroupId *string `min:"12" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroupResponse
func (CreateGroupOutput) String ¶
func (s CreateGroupOutput) String() string
String returns the string representation
type CreateGroupRequest ¶
type CreateGroupRequest struct { *aws.Request Input *CreateGroupInput Copy func(*CreateGroupInput) CreateGroupRequest }
CreateGroupRequest is the request type for the CreateGroup API operation.
func (CreateGroupRequest) Send ¶
func (r CreateGroupRequest) Send(ctx context.Context) (*CreateGroupResponse, error)
Send marshals and sends the CreateGroup API request.
type CreateGroupResponse ¶ added in v0.9.0
type CreateGroupResponse struct { *CreateGroupOutput // contains filtered or unexported fields }
CreateGroupResponse is the response type for the CreateGroup API operation.
func (*CreateGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateGroup request.
type CreateResourceInput ¶
type CreateResourceInput struct { // The name of the new resource. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The identifier associated with the organization for which the resource is // created. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The type of the new resource. The available types are equipment and room. // // Type is a required field Type ResourceType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceRequest
func (CreateResourceInput) String ¶
func (s CreateResourceInput) String() string
String returns the string representation
func (*CreateResourceInput) Validate ¶
func (s *CreateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateResourceOutput ¶
type CreateResourceOutput struct { // The identifier of the new resource. ResourceId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResourceResponse
func (CreateResourceOutput) String ¶
func (s CreateResourceOutput) String() string
String returns the string representation
type CreateResourceRequest ¶
type CreateResourceRequest struct { *aws.Request Input *CreateResourceInput Copy func(*CreateResourceInput) CreateResourceRequest }
CreateResourceRequest is the request type for the CreateResource API operation.
func (CreateResourceRequest) Send ¶
func (r CreateResourceRequest) Send(ctx context.Context) (*CreateResourceResponse, error)
Send marshals and sends the CreateResource API request.
type CreateResourceResponse ¶ added in v0.9.0
type CreateResourceResponse struct { *CreateResourceOutput // contains filtered or unexported fields }
CreateResourceResponse is the response type for the CreateResource API operation.
func (*CreateResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateResource request.
type CreateUserInput ¶
type CreateUserInput struct { // The display name for the new user. // // DisplayName is a required field DisplayName *string `type:"string" required:"true"` // The name for the new user. Simple AD or AD Connector user names have a maximum // length of 20. All others have a maximum length of 64. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The identifier of the organization for which the user is created. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The password for the new user. // // Password is a required field Password *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserRequest
func (CreateUserInput) String ¶
func (s CreateUserInput) String() string
String returns the string representation
func (*CreateUserInput) Validate ¶
func (s *CreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserOutput ¶
type CreateUserOutput struct { // The identifier for the new user. UserId *string `min:"12" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUserResponse
func (CreateUserOutput) String ¶
func (s CreateUserOutput) String() string
String returns the string representation
type CreateUserRequest ¶
type CreateUserRequest struct { *aws.Request Input *CreateUserInput Copy func(*CreateUserInput) CreateUserRequest }
CreateUserRequest is the request type for the CreateUser API operation.
func (CreateUserRequest) Send ¶
func (r CreateUserRequest) Send(ctx context.Context) (*CreateUserResponse, error)
Send marshals and sends the CreateUser API request.
type CreateUserResponse ¶ added in v0.9.0
type CreateUserResponse struct { *CreateUserOutput // contains filtered or unexported fields }
CreateUserResponse is the response type for the CreateUser API operation.
func (*CreateUserResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateUserResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateUser request.
type Delegate ¶
type Delegate struct { // The identifier for the user or group associated as the resource's delegate. // // Id is a required field Id *string `type:"string" required:"true"` // The type of the delegate: user or group. // // Type is a required field Type MemberType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The name of the attribute, which is one of the values defined in the UserAttribute enumeration. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Delegate
type DeleteAliasInput ¶
type DeleteAliasInput struct { // The aliases to be removed from the user's set of aliases. Duplicate entries // in the list are collapsed into single entries (the list is transformed into // a set). // // Alias is a required field Alias *string `min:"1" type:"string" required:"true"` // The identifier for the member (user or group) from which to have the aliases // removed. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the user exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasRequest
func (DeleteAliasInput) String ¶
func (s DeleteAliasInput) String() string
String returns the string representation
func (*DeleteAliasInput) Validate ¶
func (s *DeleteAliasInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAliasOutput ¶
type DeleteAliasOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAliasResponse
func (DeleteAliasOutput) String ¶
func (s DeleteAliasOutput) String() string
String returns the string representation
type DeleteAliasRequest ¶
type DeleteAliasRequest struct { *aws.Request Input *DeleteAliasInput Copy func(*DeleteAliasInput) DeleteAliasRequest }
DeleteAliasRequest is the request type for the DeleteAlias API operation.
func (DeleteAliasRequest) Send ¶
func (r DeleteAliasRequest) Send(ctx context.Context) (*DeleteAliasResponse, error)
Send marshals and sends the DeleteAlias API request.
type DeleteAliasResponse ¶ added in v0.9.0
type DeleteAliasResponse struct { *DeleteAliasOutput // contains filtered or unexported fields }
DeleteAliasResponse is the response type for the DeleteAlias API operation.
func (*DeleteAliasResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteAliasResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteAlias request.
type DeleteGroupInput ¶
type DeleteGroupInput struct { // The identifier of the group to be deleted. // // GroupId is a required field GroupId *string `min:"12" type:"string" required:"true"` // The organization that contains the group. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupRequest
func (DeleteGroupInput) String ¶
func (s DeleteGroupInput) String() string
String returns the string representation
func (*DeleteGroupInput) Validate ¶
func (s *DeleteGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGroupOutput ¶
type DeleteGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroupResponse
func (DeleteGroupOutput) String ¶
func (s DeleteGroupOutput) String() string
String returns the string representation
type DeleteGroupRequest ¶
type DeleteGroupRequest struct { *aws.Request Input *DeleteGroupInput Copy func(*DeleteGroupInput) DeleteGroupRequest }
DeleteGroupRequest is the request type for the DeleteGroup API operation.
func (DeleteGroupRequest) Send ¶
func (r DeleteGroupRequest) Send(ctx context.Context) (*DeleteGroupResponse, error)
Send marshals and sends the DeleteGroup API request.
type DeleteGroupResponse ¶ added in v0.9.0
type DeleteGroupResponse struct { *DeleteGroupOutput // contains filtered or unexported fields }
DeleteGroupResponse is the response type for the DeleteGroup API operation.
func (*DeleteGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteGroup request.
type DeleteMailboxPermissionsInput ¶ added in v0.4.0
type DeleteMailboxPermissionsInput struct { // The identifier of the member (user or group)that owns the mailbox. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier of the member (user or group) for which to delete granted // permissions. // // GranteeId is a required field GranteeId *string `min:"12" type:"string" required:"true"` // The identifier of the organization under which the member (user or group) // exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissionsRequest
func (DeleteMailboxPermissionsInput) String ¶ added in v0.4.0
func (s DeleteMailboxPermissionsInput) String() string
String returns the string representation
func (*DeleteMailboxPermissionsInput) Validate ¶ added in v0.4.0
func (s *DeleteMailboxPermissionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMailboxPermissionsOutput ¶ added in v0.4.0
type DeleteMailboxPermissionsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissionsResponse
func (DeleteMailboxPermissionsOutput) String ¶ added in v0.4.0
func (s DeleteMailboxPermissionsOutput) String() string
String returns the string representation
type DeleteMailboxPermissionsRequest ¶ added in v0.4.0
type DeleteMailboxPermissionsRequest struct { *aws.Request Input *DeleteMailboxPermissionsInput Copy func(*DeleteMailboxPermissionsInput) DeleteMailboxPermissionsRequest }
DeleteMailboxPermissionsRequest is the request type for the DeleteMailboxPermissions API operation.
func (DeleteMailboxPermissionsRequest) Send ¶ added in v0.4.0
func (r DeleteMailboxPermissionsRequest) Send(ctx context.Context) (*DeleteMailboxPermissionsResponse, error)
Send marshals and sends the DeleteMailboxPermissions API request.
type DeleteMailboxPermissionsResponse ¶ added in v0.9.0
type DeleteMailboxPermissionsResponse struct { *DeleteMailboxPermissionsOutput // contains filtered or unexported fields }
DeleteMailboxPermissionsResponse is the response type for the DeleteMailboxPermissions API operation.
func (*DeleteMailboxPermissionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteMailboxPermissionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteMailboxPermissions request.
type DeleteResourceInput ¶
type DeleteResourceInput struct { // The identifier associated with the organization from which the resource is // deleted. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier of the resource to be deleted. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceRequest
func (DeleteResourceInput) String ¶
func (s DeleteResourceInput) String() string
String returns the string representation
func (*DeleteResourceInput) Validate ¶
func (s *DeleteResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteResourceOutput ¶
type DeleteResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResourceResponse
func (DeleteResourceOutput) String ¶
func (s DeleteResourceOutput) String() string
String returns the string representation
type DeleteResourceRequest ¶
type DeleteResourceRequest struct { *aws.Request Input *DeleteResourceInput Copy func(*DeleteResourceInput) DeleteResourceRequest }
DeleteResourceRequest is the request type for the DeleteResource API operation.
func (DeleteResourceRequest) Send ¶
func (r DeleteResourceRequest) Send(ctx context.Context) (*DeleteResourceResponse, error)
Send marshals and sends the DeleteResource API request.
type DeleteResourceResponse ¶ added in v0.9.0
type DeleteResourceResponse struct { *DeleteResourceOutput // contains filtered or unexported fields }
DeleteResourceResponse is the response type for the DeleteResource API operation.
func (*DeleteResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteResource request.
type DeleteUserInput ¶
type DeleteUserInput struct { // The organization that contains the user to be deleted. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier of the user to be deleted. // // UserId is a required field UserId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserRequest
func (DeleteUserInput) String ¶
func (s DeleteUserInput) String() string
String returns the string representation
func (*DeleteUserInput) Validate ¶
func (s *DeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserOutput ¶
type DeleteUserOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUserResponse
func (DeleteUserOutput) String ¶
func (s DeleteUserOutput) String() string
String returns the string representation
type DeleteUserRequest ¶
type DeleteUserRequest struct { *aws.Request Input *DeleteUserInput Copy func(*DeleteUserInput) DeleteUserRequest }
DeleteUserRequest is the request type for the DeleteUser API operation.
func (DeleteUserRequest) Send ¶
func (r DeleteUserRequest) Send(ctx context.Context) (*DeleteUserResponse, error)
Send marshals and sends the DeleteUser API request.
type DeleteUserResponse ¶ added in v0.9.0
type DeleteUserResponse struct { *DeleteUserOutput // contains filtered or unexported fields }
DeleteUserResponse is the response type for the DeleteUser API operation.
func (*DeleteUserResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteUserResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteUser request.
type DeregisterFromWorkMailInput ¶
type DeregisterFromWorkMailInput struct { // The identifier for the member (user or group) to be updated. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the Amazon WorkMail entity // exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailRequest
func (DeregisterFromWorkMailInput) String ¶
func (s DeregisterFromWorkMailInput) String() string
String returns the string representation
func (*DeregisterFromWorkMailInput) Validate ¶
func (s *DeregisterFromWorkMailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterFromWorkMailOutput ¶
type DeregisterFromWorkMailOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMailResponse
func (DeregisterFromWorkMailOutput) String ¶
func (s DeregisterFromWorkMailOutput) String() string
String returns the string representation
type DeregisterFromWorkMailRequest ¶
type DeregisterFromWorkMailRequest struct { *aws.Request Input *DeregisterFromWorkMailInput Copy func(*DeregisterFromWorkMailInput) DeregisterFromWorkMailRequest }
DeregisterFromWorkMailRequest is the request type for the DeregisterFromWorkMail API operation.
func (DeregisterFromWorkMailRequest) Send ¶
func (r DeregisterFromWorkMailRequest) Send(ctx context.Context) (*DeregisterFromWorkMailResponse, error)
Send marshals and sends the DeregisterFromWorkMail API request.
type DeregisterFromWorkMailResponse ¶ added in v0.9.0
type DeregisterFromWorkMailResponse struct { *DeregisterFromWorkMailOutput // contains filtered or unexported fields }
DeregisterFromWorkMailResponse is the response type for the DeregisterFromWorkMail API operation.
func (*DeregisterFromWorkMailResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeregisterFromWorkMailResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeregisterFromWorkMail request.
type DescribeGroupInput ¶
type DescribeGroupInput struct { // The identifier for the group to be described. // // GroupId is a required field GroupId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the group exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupRequest
func (DescribeGroupInput) String ¶
func (s DescribeGroupInput) String() string
String returns the string representation
func (*DescribeGroupInput) Validate ¶
func (s *DescribeGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGroupOutput ¶
type DescribeGroupOutput struct { // The date and time when a user was deregistered from WorkMail, in UNIX epoch // time format. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The email of the described group. Email *string `min:"1" type:"string"` // The date and time when a user was registered to WorkMail, in UNIX epoch time // format. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the described group. GroupId *string `min:"12" type:"string"` // The name of the described group. Name *string `min:"1" type:"string"` // The state of the user: enabled (registered to Amazon WorkMail) or disabled // (deregistered or never registered to WorkMail). State EntityState `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroupResponse
func (DescribeGroupOutput) String ¶
func (s DescribeGroupOutput) String() string
String returns the string representation
type DescribeGroupRequest ¶
type DescribeGroupRequest struct { *aws.Request Input *DescribeGroupInput Copy func(*DescribeGroupInput) DescribeGroupRequest }
DescribeGroupRequest is the request type for the DescribeGroup API operation.
func (DescribeGroupRequest) Send ¶
func (r DescribeGroupRequest) Send(ctx context.Context) (*DescribeGroupResponse, error)
Send marshals and sends the DescribeGroup API request.
type DescribeGroupResponse ¶ added in v0.9.0
type DescribeGroupResponse struct { *DescribeGroupOutput // contains filtered or unexported fields }
DescribeGroupResponse is the response type for the DescribeGroup API operation.
func (*DescribeGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeGroup request.
type DescribeOrganizationInput ¶
type DescribeOrganizationInput struct { // The identifier for the organization to be described. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationRequest
func (DescribeOrganizationInput) String ¶
func (s DescribeOrganizationInput) String() string
String returns the string representation
func (*DescribeOrganizationInput) Validate ¶
func (s *DescribeOrganizationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeOrganizationOutput ¶
type DescribeOrganizationOutput struct { // The alias for an organization. Alias *string `min:"1" type:"string"` // The date at which the organization became usable in the WorkMail context, // in UNIX epoch time format. CompletedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The default mail domain associated with the organization. DefaultMailDomain *string `type:"string"` // The identifier for the directory associated with an Amazon WorkMail organization. DirectoryId *string `type:"string"` // The type of directory associated with the WorkMail organization. DirectoryType *string `type:"string"` // (Optional) The error message indicating if unexpected behavior was encountered // with regards to the organization. ErrorMessage *string `type:"string"` // The identifier of an organization. OrganizationId *string `type:"string"` // The state of an organization. State *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganizationResponse
func (DescribeOrganizationOutput) String ¶
func (s DescribeOrganizationOutput) String() string
String returns the string representation
type DescribeOrganizationRequest ¶
type DescribeOrganizationRequest struct { *aws.Request Input *DescribeOrganizationInput Copy func(*DescribeOrganizationInput) DescribeOrganizationRequest }
DescribeOrganizationRequest is the request type for the DescribeOrganization API operation.
func (DescribeOrganizationRequest) Send ¶
func (r DescribeOrganizationRequest) Send(ctx context.Context) (*DescribeOrganizationResponse, error)
Send marshals and sends the DescribeOrganization API request.
type DescribeOrganizationResponse ¶ added in v0.9.0
type DescribeOrganizationResponse struct { *DescribeOrganizationOutput // contains filtered or unexported fields }
DescribeOrganizationResponse is the response type for the DescribeOrganization API operation.
func (*DescribeOrganizationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeOrganizationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeOrganization request.
type DescribeResourceInput ¶
type DescribeResourceInput struct { // The identifier associated with the organization for which the resource is // described. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier of the resource to be described. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceRequest
func (DescribeResourceInput) String ¶
func (s DescribeResourceInput) String() string
String returns the string representation
func (*DescribeResourceInput) Validate ¶
func (s *DescribeResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeResourceOutput ¶
type DescribeResourceOutput struct { // The booking options for the described resource. BookingOptions *BookingOptions `type:"structure"` // The date and time when a resource was disabled from WorkMail, in UNIX epoch // time format. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The email of the described resource. Email *string `min:"1" type:"string"` // The date and time when a resource was enabled for WorkMail, in UNIX epoch // time format. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The name of the described resource. Name *string `min:"1" type:"string"` // The identifier of the described resource. ResourceId *string `type:"string"` // The state of the resource: enabled (registered to Amazon WorkMail) or disabled // (deregistered or never registered to WorkMail). State EntityState `type:"string" enum:"true"` // The type of the described resource. Type ResourceType `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResourceResponse
func (DescribeResourceOutput) String ¶
func (s DescribeResourceOutput) String() string
String returns the string representation
type DescribeResourceRequest ¶
type DescribeResourceRequest struct { *aws.Request Input *DescribeResourceInput Copy func(*DescribeResourceInput) DescribeResourceRequest }
DescribeResourceRequest is the request type for the DescribeResource API operation.
func (DescribeResourceRequest) Send ¶
func (r DescribeResourceRequest) Send(ctx context.Context) (*DescribeResourceResponse, error)
Send marshals and sends the DescribeResource API request.
type DescribeResourceResponse ¶ added in v0.9.0
type DescribeResourceResponse struct { *DescribeResourceOutput // contains filtered or unexported fields }
DescribeResourceResponse is the response type for the DescribeResource API operation.
func (*DescribeResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeResource request.
type DescribeUserInput ¶
type DescribeUserInput struct { // The identifier for the organization under which the user exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier for the user to be described. // // UserId is a required field UserId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserRequest
func (DescribeUserInput) String ¶
func (s DescribeUserInput) String() string
String returns the string representation
func (*DescribeUserInput) Validate ¶
func (s *DescribeUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserOutput ¶
type DescribeUserOutput struct { // The date and time at which the user was disabled for Amazon WorkMail usage, // in UNIX epoch time format. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The display name of the user. DisplayName *string `type:"string"` // The email of the user. Email *string `min:"1" type:"string"` // The date and time at which the user was enabled for Amazon WorkMail usage, // in UNIX epoch time format. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The name for the user. Name *string `min:"1" type:"string"` // The state of a user: enabled (registered to Amazon WorkMail) or disabled // (deregistered or never registered to WorkMail). State EntityState `type:"string" enum:"true"` // The identifier for the described user. UserId *string `min:"12" type:"string"` // In certain cases, other entities are modeled as users. If interoperability // is enabled, resources are imported into Amazon WorkMail as users. Because // different 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 UserRole `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUserResponse
func (DescribeUserOutput) String ¶
func (s DescribeUserOutput) String() string
String returns the string representation
type DescribeUserRequest ¶
type DescribeUserRequest struct { *aws.Request Input *DescribeUserInput Copy func(*DescribeUserInput) DescribeUserRequest }
DescribeUserRequest is the request type for the DescribeUser API operation.
func (DescribeUserRequest) Send ¶
func (r DescribeUserRequest) Send(ctx context.Context) (*DescribeUserResponse, error)
Send marshals and sends the DescribeUser API request.
type DescribeUserResponse ¶ added in v0.9.0
type DescribeUserResponse struct { *DescribeUserOutput // contains filtered or unexported fields }
DescribeUserResponse is the response type for the DescribeUser API operation.
func (*DescribeUserResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeUserResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeUser request.
type DisassociateDelegateFromResourceInput ¶
type DisassociateDelegateFromResourceInput struct { // The identifier for the member (user, group) to be removed from the resource's // delegates. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the resource exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier of the resource from which delegates' set members are removed. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceRequest
func (DisassociateDelegateFromResourceInput) String ¶
func (s DisassociateDelegateFromResourceInput) String() string
String returns the string representation
func (*DisassociateDelegateFromResourceInput) Validate ¶
func (s *DisassociateDelegateFromResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateDelegateFromResourceOutput ¶
type DisassociateDelegateFromResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResourceResponse
func (DisassociateDelegateFromResourceOutput) String ¶
func (s DisassociateDelegateFromResourceOutput) String() string
String returns the string representation
type DisassociateDelegateFromResourceRequest ¶
type DisassociateDelegateFromResourceRequest struct { *aws.Request Input *DisassociateDelegateFromResourceInput Copy func(*DisassociateDelegateFromResourceInput) DisassociateDelegateFromResourceRequest }
DisassociateDelegateFromResourceRequest is the request type for the DisassociateDelegateFromResource API operation.
func (DisassociateDelegateFromResourceRequest) Send ¶
func (r DisassociateDelegateFromResourceRequest) Send(ctx context.Context) (*DisassociateDelegateFromResourceResponse, error)
Send marshals and sends the DisassociateDelegateFromResource API request.
type DisassociateDelegateFromResourceResponse ¶ added in v0.9.0
type DisassociateDelegateFromResourceResponse struct { *DisassociateDelegateFromResourceOutput // contains filtered or unexported fields }
DisassociateDelegateFromResourceResponse is the response type for the DisassociateDelegateFromResource API operation.
func (*DisassociateDelegateFromResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DisassociateDelegateFromResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DisassociateDelegateFromResource request.
type DisassociateMemberFromGroupInput ¶
type DisassociateMemberFromGroupInput struct { // The identifier for the group from which members are removed. // // GroupId is a required field GroupId *string `min:"12" type:"string" required:"true"` // The identifier for the member to be removed to the group. // // MemberId is a required field MemberId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the group exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupRequest
func (DisassociateMemberFromGroupInput) String ¶
func (s DisassociateMemberFromGroupInput) String() string
String returns the string representation
func (*DisassociateMemberFromGroupInput) Validate ¶
func (s *DisassociateMemberFromGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateMemberFromGroupOutput ¶
type DisassociateMemberFromGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroupResponse
func (DisassociateMemberFromGroupOutput) String ¶
func (s DisassociateMemberFromGroupOutput) String() string
String returns the string representation
type DisassociateMemberFromGroupRequest ¶
type DisassociateMemberFromGroupRequest struct { *aws.Request Input *DisassociateMemberFromGroupInput Copy func(*DisassociateMemberFromGroupInput) DisassociateMemberFromGroupRequest }
DisassociateMemberFromGroupRequest is the request type for the DisassociateMemberFromGroup API operation.
func (DisassociateMemberFromGroupRequest) Send ¶
func (r DisassociateMemberFromGroupRequest) Send(ctx context.Context) (*DisassociateMemberFromGroupResponse, error)
Send marshals and sends the DisassociateMemberFromGroup API request.
type DisassociateMemberFromGroupResponse ¶ added in v0.9.0
type DisassociateMemberFromGroupResponse struct { *DisassociateMemberFromGroupOutput // contains filtered or unexported fields }
DisassociateMemberFromGroupResponse is the response type for the DisassociateMemberFromGroup API operation.
func (*DisassociateMemberFromGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DisassociateMemberFromGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DisassociateMemberFromGroup request.
type EntityState ¶
type EntityState string
const ( EntityStateEnabled EntityState = "ENABLED" EntityStateDisabled EntityState = "DISABLED" EntityStateDeleted EntityState = "DELETED" )
Enum values for EntityState
func (EntityState) MarshalValue ¶ added in v0.3.0
func (enum EntityState) MarshalValue() (string, error)
func (EntityState) MarshalValueBuf ¶ added in v0.3.0
func (enum EntityState) MarshalValueBuf(b []byte) ([]byte, error)
type GetMailboxDetailsInput ¶ added in v0.9.0
type GetMailboxDetailsInput struct { // The identifier for the organization that contains the user whose mailbox // details are being requested. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier for the user whose mailbox details are being requested. // // UserId is a required field UserId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetailsRequest
func (GetMailboxDetailsInput) String ¶ added in v0.9.0
func (s GetMailboxDetailsInput) String() string
String returns the string representation
func (*GetMailboxDetailsInput) Validate ¶ added in v0.9.0
func (s *GetMailboxDetailsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMailboxDetailsOutput ¶ added in v0.9.0
type GetMailboxDetailsOutput struct { // The maximum allowed mailbox size, in MB, for the specified user. MailboxQuota *int64 `min:"1" type:"integer"` // The current mailbox size, in MB, for the specified user. MailboxSize *float64 `type:"double"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetailsResponse
func (GetMailboxDetailsOutput) String ¶ added in v0.9.0
func (s GetMailboxDetailsOutput) String() string
String returns the string representation
type GetMailboxDetailsRequest ¶ added in v0.9.0
type GetMailboxDetailsRequest struct { *aws.Request Input *GetMailboxDetailsInput Copy func(*GetMailboxDetailsInput) GetMailboxDetailsRequest }
GetMailboxDetailsRequest is the request type for the GetMailboxDetails API operation.
func (GetMailboxDetailsRequest) Send ¶ added in v0.9.0
func (r GetMailboxDetailsRequest) Send(ctx context.Context) (*GetMailboxDetailsResponse, error)
Send marshals and sends the GetMailboxDetails API request.
type GetMailboxDetailsResponse ¶ added in v0.9.0
type GetMailboxDetailsResponse struct { *GetMailboxDetailsOutput // contains filtered or unexported fields }
GetMailboxDetailsResponse is the response type for the GetMailboxDetails API operation.
func (*GetMailboxDetailsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetMailboxDetailsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetMailboxDetails request.
type Group ¶
type Group struct { // The date indicating when the group was disabled from Amazon WorkMail use. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The email of the group. Email *string `min:"1" type:"string"` // The date indicating when the group was enabled for Amazon WorkMail use. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the group. Id *string `min:"12" type:"string"` // The name of the group. Name *string `min:"1" type:"string"` // The state of the group, which can be ENABLED, DISABLED, or DELETED. State EntityState `type:"string" enum:"true"` // contains filtered or unexported fields }
The representation of an Amazon WorkMail group. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Group
type ListAliasesInput ¶
type ListAliasesInput struct { // The identifier for the entity for which to list the aliases. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier for the organization under which the entity exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesRequest
func (ListAliasesInput) String ¶
func (s ListAliasesInput) String() string
String returns the string representation
func (*ListAliasesInput) Validate ¶
func (s *ListAliasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAliasesOutput ¶
type ListAliasesOutput struct { // The entity's paginated aliases. Aliases []string `type:"list"` // The token to use to retrieve the next page of results. The value is "null" // when there are no more results to return. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliasesResponse
func (ListAliasesOutput) String ¶
func (s ListAliasesOutput) String() string
String returns the string representation
type ListAliasesPaginator ¶ added in v0.9.0
ListAliasesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListAliasesPaginator ¶ added in v0.9.0
func NewListAliasesPaginator(req ListAliasesRequest) ListAliasesPaginator
NewListAliasesRequestPaginator returns a paginator for ListAliases. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListAliasesRequest(input) p := workmail.NewListAliasesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListAliasesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListAliasesPaginator) CurrentPage() *ListAliasesOutput
type ListAliasesRequest ¶
type ListAliasesRequest struct { *aws.Request Input *ListAliasesInput Copy func(*ListAliasesInput) ListAliasesRequest }
ListAliasesRequest is the request type for the ListAliases API operation.
func (ListAliasesRequest) Send ¶
func (r ListAliasesRequest) Send(ctx context.Context) (*ListAliasesResponse, error)
Send marshals and sends the ListAliases API request.
type ListAliasesResponse ¶ added in v0.9.0
type ListAliasesResponse struct { *ListAliasesOutput // contains filtered or unexported fields }
ListAliasesResponse is the response type for the ListAliases API operation.
func (*ListAliasesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListAliasesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListAliases request.
type ListGroupMembersInput ¶
type ListGroupMembersInput struct { // The identifier for the group to which the members (users or groups) are associated. // // GroupId is a required field GroupId *string `min:"12" type:"string" required:"true"` // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier for the organization under which the group exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersRequest
func (ListGroupMembersInput) String ¶
func (s ListGroupMembersInput) String() string
String returns the string representation
func (*ListGroupMembersInput) Validate ¶
func (s *ListGroupMembersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupMembersOutput ¶
type ListGroupMembersOutput struct { // The members associated to the group. Members []Member `type:"list"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembersResponse
func (ListGroupMembersOutput) String ¶
func (s ListGroupMembersOutput) String() string
String returns the string representation
type ListGroupMembersPaginator ¶ added in v0.9.0
ListGroupMembersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListGroupMembersPaginator ¶ added in v0.9.0
func NewListGroupMembersPaginator(req ListGroupMembersRequest) ListGroupMembersPaginator
NewListGroupMembersRequestPaginator returns a paginator for ListGroupMembers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListGroupMembersRequest(input) p := workmail.NewListGroupMembersRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListGroupMembersPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListGroupMembersPaginator) CurrentPage() *ListGroupMembersOutput
type ListGroupMembersRequest ¶
type ListGroupMembersRequest struct { *aws.Request Input *ListGroupMembersInput Copy func(*ListGroupMembersInput) ListGroupMembersRequest }
ListGroupMembersRequest is the request type for the ListGroupMembers API operation.
func (ListGroupMembersRequest) Send ¶
func (r ListGroupMembersRequest) Send(ctx context.Context) (*ListGroupMembersResponse, error)
Send marshals and sends the ListGroupMembers API request.
type ListGroupMembersResponse ¶ added in v0.9.0
type ListGroupMembersResponse struct { *ListGroupMembersOutput // contains filtered or unexported fields }
ListGroupMembersResponse is the response type for the ListGroupMembers API operation.
func (*ListGroupMembersResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListGroupMembersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListGroupMembers request.
type ListGroupsInput ¶
type ListGroupsInput struct { // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier for the organization under which the groups exist. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsRequest
func (ListGroupsInput) String ¶
func (s ListGroupsInput) String() string
String returns the string representation
func (*ListGroupsInput) Validate ¶
func (s *ListGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupsOutput ¶
type ListGroupsOutput struct { // The overview of groups for an organization. Groups []Group `type:"list"` // The token to use to retrieve the next page of results. The value is "null" // when there are no more results to return. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsResponse
func (ListGroupsOutput) String ¶
func (s ListGroupsOutput) String() string
String returns the string representation
type ListGroupsPaginator ¶ added in v0.9.0
ListGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListGroupsPaginator ¶ added in v0.9.0
func NewListGroupsPaginator(req ListGroupsRequest) ListGroupsPaginator
NewListGroupsRequestPaginator returns a paginator for ListGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListGroupsRequest(input) p := workmail.NewListGroupsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListGroupsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListGroupsPaginator) CurrentPage() *ListGroupsOutput
type ListGroupsRequest ¶
type ListGroupsRequest struct { *aws.Request Input *ListGroupsInput Copy func(*ListGroupsInput) ListGroupsRequest }
ListGroupsRequest is the request type for the ListGroups API operation.
func (ListGroupsRequest) Send ¶
func (r ListGroupsRequest) Send(ctx context.Context) (*ListGroupsResponse, error)
Send marshals and sends the ListGroups API request.
type ListGroupsResponse ¶ added in v0.9.0
type ListGroupsResponse struct { *ListGroupsOutput // contains filtered or unexported fields }
ListGroupsResponse is the response type for the ListGroups API operation.
func (*ListGroupsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListGroupsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListGroups request.
type ListMailboxPermissionsInput ¶ added in v0.4.0
type ListMailboxPermissionsInput struct { // The identifier of the user, group, or resource for which to list mailbox // permissions. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier of the organization under which the user, group, or resource // exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissionsRequest
func (ListMailboxPermissionsInput) String ¶ added in v0.4.0
func (s ListMailboxPermissionsInput) String() string
String returns the string representation
func (*ListMailboxPermissionsInput) Validate ¶ added in v0.4.0
func (s *ListMailboxPermissionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListMailboxPermissionsOutput ¶ added in v0.4.0
type ListMailboxPermissionsOutput struct { // The token to use to retrieve the next page of results. The value is "null" // when there are no more results to return. NextToken *string `min:"1" type:"string"` // One page of the user, group, or resource mailbox permissions. Permissions []Permission `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissionsResponse
func (ListMailboxPermissionsOutput) String ¶ added in v0.4.0
func (s ListMailboxPermissionsOutput) String() string
String returns the string representation
type ListMailboxPermissionsPaginator ¶ added in v0.9.0
ListMailboxPermissionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListMailboxPermissionsPaginator ¶ added in v0.9.0
func NewListMailboxPermissionsPaginator(req ListMailboxPermissionsRequest) ListMailboxPermissionsPaginator
NewListMailboxPermissionsRequestPaginator returns a paginator for ListMailboxPermissions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListMailboxPermissionsRequest(input) p := workmail.NewListMailboxPermissionsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListMailboxPermissionsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListMailboxPermissionsPaginator) CurrentPage() *ListMailboxPermissionsOutput
type ListMailboxPermissionsRequest ¶ added in v0.4.0
type ListMailboxPermissionsRequest struct { *aws.Request Input *ListMailboxPermissionsInput Copy func(*ListMailboxPermissionsInput) ListMailboxPermissionsRequest }
ListMailboxPermissionsRequest is the request type for the ListMailboxPermissions API operation.
func (ListMailboxPermissionsRequest) Send ¶ added in v0.4.0
func (r ListMailboxPermissionsRequest) Send(ctx context.Context) (*ListMailboxPermissionsResponse, error)
Send marshals and sends the ListMailboxPermissions API request.
type ListMailboxPermissionsResponse ¶ added in v0.9.0
type ListMailboxPermissionsResponse struct { *ListMailboxPermissionsOutput // contains filtered or unexported fields }
ListMailboxPermissionsResponse is the response type for the ListMailboxPermissions API operation.
func (*ListMailboxPermissionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListMailboxPermissionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListMailboxPermissions request.
type ListOrganizationsInput ¶
type ListOrganizationsInput struct { // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsRequest
func (ListOrganizationsInput) String ¶
func (s ListOrganizationsInput) String() string
String returns the string representation
func (*ListOrganizationsInput) Validate ¶
func (s *ListOrganizationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListOrganizationsOutput ¶
type ListOrganizationsOutput struct { // The token to use to retrieve the next page of results. The value is "null" // when there are no more results to return. NextToken *string `min:"1" type:"string"` // The overview of owned organizations presented as a list of organization summaries. OrganizationSummaries []OrganizationSummary `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizationsResponse
func (ListOrganizationsOutput) String ¶
func (s ListOrganizationsOutput) String() string
String returns the string representation
type ListOrganizationsPaginator ¶ added in v0.9.0
ListOrganizationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListOrganizationsPaginator ¶ added in v0.9.0
func NewListOrganizationsPaginator(req ListOrganizationsRequest) ListOrganizationsPaginator
NewListOrganizationsRequestPaginator returns a paginator for ListOrganizations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListOrganizationsRequest(input) p := workmail.NewListOrganizationsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListOrganizationsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListOrganizationsPaginator) CurrentPage() *ListOrganizationsOutput
type ListOrganizationsRequest ¶
type ListOrganizationsRequest struct { *aws.Request Input *ListOrganizationsInput Copy func(*ListOrganizationsInput) ListOrganizationsRequest }
ListOrganizationsRequest is the request type for the ListOrganizations API operation.
func (ListOrganizationsRequest) Send ¶
func (r ListOrganizationsRequest) Send(ctx context.Context) (*ListOrganizationsResponse, error)
Send marshals and sends the ListOrganizations API request.
type ListOrganizationsResponse ¶ added in v0.9.0
type ListOrganizationsResponse struct { *ListOrganizationsOutput // contains filtered or unexported fields }
ListOrganizationsResponse is the response type for the ListOrganizations API operation.
func (*ListOrganizationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListOrganizationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListOrganizations request.
type ListResourceDelegatesInput ¶
type ListResourceDelegatesInput struct { // The number of maximum results in a page. MaxResults *int64 `min:"1" type:"integer"` // The token used to paginate through the delegates associated with a resource. NextToken *string `min:"1" type:"string"` // The identifier for the organization that contains the resource for which // delegates are listed. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier for the resource whose delegates are listed. // // ResourceId is a required field ResourceId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesRequest
func (ListResourceDelegatesInput) String ¶
func (s ListResourceDelegatesInput) String() string
String returns the string representation
func (*ListResourceDelegatesInput) Validate ¶
func (s *ListResourceDelegatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListResourceDelegatesOutput ¶
type ListResourceDelegatesOutput struct { // One page of the resource's delegates. Delegates []Delegate `type:"list"` // The token used to paginate through the delegates associated with a resource. // While results are still available, it has an associated value. When the last // page is reached, the token is empty. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegatesResponse
func (ListResourceDelegatesOutput) String ¶
func (s ListResourceDelegatesOutput) String() string
String returns the string representation
type ListResourceDelegatesPaginator ¶ added in v0.9.0
ListResourceDelegatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListResourceDelegatesPaginator ¶ added in v0.9.0
func NewListResourceDelegatesPaginator(req ListResourceDelegatesRequest) ListResourceDelegatesPaginator
NewListResourceDelegatesRequestPaginator returns a paginator for ListResourceDelegates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListResourceDelegatesRequest(input) p := workmail.NewListResourceDelegatesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListResourceDelegatesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListResourceDelegatesPaginator) CurrentPage() *ListResourceDelegatesOutput
type ListResourceDelegatesRequest ¶
type ListResourceDelegatesRequest struct { *aws.Request Input *ListResourceDelegatesInput Copy func(*ListResourceDelegatesInput) ListResourceDelegatesRequest }
ListResourceDelegatesRequest is the request type for the ListResourceDelegates API operation.
func (ListResourceDelegatesRequest) Send ¶
func (r ListResourceDelegatesRequest) Send(ctx context.Context) (*ListResourceDelegatesResponse, error)
Send marshals and sends the ListResourceDelegates API request.
type ListResourceDelegatesResponse ¶ added in v0.9.0
type ListResourceDelegatesResponse struct { *ListResourceDelegatesOutput // contains filtered or unexported fields }
ListResourceDelegatesResponse is the response type for the ListResourceDelegates API operation.
func (*ListResourceDelegatesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListResourceDelegatesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListResourceDelegates request.
type ListResourcesInput ¶
type ListResourcesInput struct { // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier for the organization under which the resources exist. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesRequest
func (ListResourcesInput) String ¶
func (s ListResourcesInput) String() string
String returns the string representation
func (*ListResourcesInput) Validate ¶
func (s *ListResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListResourcesOutput ¶
type ListResourcesOutput struct { // The token used to paginate through all the organization's resources. While // results are still available, it has an associated value. When the last page // is reached, the token is empty. NextToken *string `min:"1" type:"string"` // One page of the organization's resource representation. Resources []Resource `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourcesResponse
func (ListResourcesOutput) String ¶
func (s ListResourcesOutput) String() string
String returns the string representation
type ListResourcesPaginator ¶ added in v0.9.0
ListResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListResourcesPaginator ¶ added in v0.9.0
func NewListResourcesPaginator(req ListResourcesRequest) ListResourcesPaginator
NewListResourcesRequestPaginator returns a paginator for ListResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListResourcesRequest(input) p := workmail.NewListResourcesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListResourcesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListResourcesPaginator) CurrentPage() *ListResourcesOutput
type ListResourcesRequest ¶
type ListResourcesRequest struct { *aws.Request Input *ListResourcesInput Copy func(*ListResourcesInput) ListResourcesRequest }
ListResourcesRequest is the request type for the ListResources API operation.
func (ListResourcesRequest) Send ¶
func (r ListResourcesRequest) Send(ctx context.Context) (*ListResourcesResponse, error)
Send marshals and sends the ListResources API request.
type ListResourcesResponse ¶ added in v0.9.0
type ListResourcesResponse struct { *ListResourcesOutput // contains filtered or unexported fields }
ListResourcesResponse is the response type for the ListResources API operation.
func (*ListResourcesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListResourcesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListResources request.
type ListUsersInput ¶
type ListUsersInput struct { // The maximum number of results to return in a single call. MaxResults *int64 `min:"1" type:"integer"` // The token to use to retrieve the next page of results. The first call does // not contain any tokens. NextToken *string `min:"1" type:"string"` // The identifier for the organization under which the users exist. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersRequest
func (ListUsersInput) String ¶
func (s ListUsersInput) String() string
String returns the string representation
func (*ListUsersInput) Validate ¶
func (s *ListUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUsersOutput ¶
type ListUsersOutput struct { // The token to use to retrieve the next page of results. This value is `null` // when there are no more results to return. NextToken *string `min:"1" type:"string"` // The overview of users for an organization. Users []User `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsersResponse
func (ListUsersOutput) String ¶
func (s ListUsersOutput) String() string
String returns the string representation
type ListUsersPaginator ¶ added in v0.9.0
ListUsersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListUsersPaginator ¶ added in v0.9.0
func NewListUsersPaginator(req ListUsersRequest) ListUsersPaginator
NewListUsersRequestPaginator returns a paginator for ListUsers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListUsersRequest(input) p := workmail.NewListUsersRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListUsersPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListUsersPaginator) CurrentPage() *ListUsersOutput
type ListUsersRequest ¶
type ListUsersRequest struct { *aws.Request Input *ListUsersInput Copy func(*ListUsersInput) ListUsersRequest }
ListUsersRequest is the request type for the ListUsers API operation.
func (ListUsersRequest) Send ¶
func (r ListUsersRequest) Send(ctx context.Context) (*ListUsersResponse, error)
Send marshals and sends the ListUsers API request.
type ListUsersResponse ¶ added in v0.9.0
type ListUsersResponse struct { *ListUsersOutput // contains filtered or unexported fields }
ListUsersResponse is the response type for the ListUsers API operation.
func (*ListUsersResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListUsersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListUsers request.
type Member ¶
type Member struct { // The date indicating when the member was disabled from Amazon WorkMail use. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The date indicating when the member was enabled for Amazon WorkMail use. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the member. Id *string `type:"string"` // The name of the member. Name *string `type:"string"` // The state of the member, which can be ENABLED, DISABLED, or DELETED. State EntityState `type:"string" enum:"true"` // A member can be a user or group. Type MemberType `type:"string" enum:"true"` // contains filtered or unexported fields }
The representation of a user or group. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Member
type MemberType ¶
type MemberType string
const ( MemberTypeGroup MemberType = "GROUP" MemberTypeUser MemberType = "USER" )
Enum values for MemberType
func (MemberType) MarshalValue ¶ added in v0.3.0
func (enum MemberType) MarshalValue() (string, error)
func (MemberType) MarshalValueBuf ¶ added in v0.3.0
func (enum MemberType) MarshalValueBuf(b []byte) ([]byte, error)
type OrganizationSummary ¶
type OrganizationSummary struct { // The alias associated with the organization. Alias *string `min:"1" type:"string"` // The error message associated with the organization. It is only present if // unexpected behavior has occurred with regards to the organization. It provides // insight or solutions regarding unexpected behavior. ErrorMessage *string `type:"string"` // The identifier associated with the organization. OrganizationId *string `type:"string"` // The state associated with the organization. State *string `type:"string"` // contains filtered or unexported fields }
The representation of an organization. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/OrganizationSummary
func (OrganizationSummary) String ¶
func (s OrganizationSummary) String() string
String returns the string representation
type Permission ¶ added in v0.4.0
type Permission struct { // The identifier of the user, group, or resource to which the permissions are // granted. // // GranteeId is a required field GranteeId *string `min:"12" type:"string" required:"true"` // The type of user, group, or resource referred to in GranteeId. // // GranteeType is a required field GranteeType MemberType `type:"string" required:"true" enum:"true"` // The permissions granted to the grantee. SEND_AS allows the grantee to send // email as the owner of the mailbox (the grantee is not mentioned on these // emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the // owner of the mailbox (the grantee is not mentioned as the physical sender // of these emails). FULL_ACCESS allows the grantee full access to the mailbox, // irrespective of other folder-level permissions set on the mailbox. // // PermissionValues is a required field PermissionValues []PermissionType `type:"list" required:"true"` // contains filtered or unexported fields }
Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Permission
func (Permission) String ¶ added in v0.4.0
func (s Permission) String() string
String returns the string representation
type PermissionType ¶ added in v0.4.0
type PermissionType string
const ( PermissionTypeFullAccess PermissionType = "FULL_ACCESS" PermissionTypeSendAs PermissionType = "SEND_AS" PermissionTypeSendOnBehalf PermissionType = "SEND_ON_BEHALF" )
Enum values for PermissionType
func (PermissionType) MarshalValue ¶ added in v0.4.0
func (enum PermissionType) MarshalValue() (string, error)
func (PermissionType) MarshalValueBuf ¶ added in v0.4.0
func (enum PermissionType) MarshalValueBuf(b []byte) ([]byte, error)
type PutMailboxPermissionsInput ¶ added in v0.4.0
type PutMailboxPermissionsInput struct { // The identifier of the user, group, or resource for which to update mailbox // permissions. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier of the user, group, or resource to which to grant the permissions. // // GranteeId is a required field GranteeId *string `min:"12" type:"string" required:"true"` // The identifier of the organization under which the user, group, or resource // exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The permissions granted to the grantee. SEND_AS allows the grantee to send // email as the owner of the mailbox (the grantee is not mentioned on these // emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the // owner of the mailbox (the grantee is not mentioned as the physical sender // of these emails). FULL_ACCESS allows the grantee full access to the mailbox, // irrespective of other folder-level permissions set on the mailbox. // // PermissionValues is a required field PermissionValues []PermissionType `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissionsRequest
func (PutMailboxPermissionsInput) String ¶ added in v0.4.0
func (s PutMailboxPermissionsInput) String() string
String returns the string representation
func (*PutMailboxPermissionsInput) Validate ¶ added in v0.4.0
func (s *PutMailboxPermissionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMailboxPermissionsOutput ¶ added in v0.4.0
type PutMailboxPermissionsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissionsResponse
func (PutMailboxPermissionsOutput) String ¶ added in v0.4.0
func (s PutMailboxPermissionsOutput) String() string
String returns the string representation
type PutMailboxPermissionsRequest ¶ added in v0.4.0
type PutMailboxPermissionsRequest struct { *aws.Request Input *PutMailboxPermissionsInput Copy func(*PutMailboxPermissionsInput) PutMailboxPermissionsRequest }
PutMailboxPermissionsRequest is the request type for the PutMailboxPermissions API operation.
func (PutMailboxPermissionsRequest) Send ¶ added in v0.4.0
func (r PutMailboxPermissionsRequest) Send(ctx context.Context) (*PutMailboxPermissionsResponse, error)
Send marshals and sends the PutMailboxPermissions API request.
type PutMailboxPermissionsResponse ¶ added in v0.9.0
type PutMailboxPermissionsResponse struct { *PutMailboxPermissionsOutput // contains filtered or unexported fields }
PutMailboxPermissionsResponse is the response type for the PutMailboxPermissions API operation.
func (*PutMailboxPermissionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutMailboxPermissionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutMailboxPermissions request.
type RegisterToWorkMailInput ¶
type RegisterToWorkMailInput struct { // The email for the user, group, or resource to be updated. // // Email is a required field Email *string `min:"1" type:"string" required:"true"` // The identifier for the user, group, or resource to be updated. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The identifier for the organization under which the user, group, or resource // exists. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailRequest
func (RegisterToWorkMailInput) String ¶
func (s RegisterToWorkMailInput) String() string
String returns the string representation
func (*RegisterToWorkMailInput) Validate ¶
func (s *RegisterToWorkMailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterToWorkMailOutput ¶
type RegisterToWorkMailOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMailResponse
func (RegisterToWorkMailOutput) String ¶
func (s RegisterToWorkMailOutput) String() string
String returns the string representation
type RegisterToWorkMailRequest ¶
type RegisterToWorkMailRequest struct { *aws.Request Input *RegisterToWorkMailInput Copy func(*RegisterToWorkMailInput) RegisterToWorkMailRequest }
RegisterToWorkMailRequest is the request type for the RegisterToWorkMail API operation.
func (RegisterToWorkMailRequest) Send ¶
func (r RegisterToWorkMailRequest) Send(ctx context.Context) (*RegisterToWorkMailResponse, error)
Send marshals and sends the RegisterToWorkMail API request.
type RegisterToWorkMailResponse ¶ added in v0.9.0
type RegisterToWorkMailResponse struct { *RegisterToWorkMailOutput // contains filtered or unexported fields }
RegisterToWorkMailResponse is the response type for the RegisterToWorkMail API operation.
func (*RegisterToWorkMailResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RegisterToWorkMailResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RegisterToWorkMail request.
type ResetPasswordInput ¶
type ResetPasswordInput struct { // The identifier of the organization that contains the user for which the password // is reset. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The new password for the user. // // Password is a required field Password *string `type:"string" required:"true"` // The identifier of the user for whom the password is reset. // // UserId is a required field UserId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordRequest
func (ResetPasswordInput) String ¶
func (s ResetPasswordInput) String() string
String returns the string representation
func (*ResetPasswordInput) Validate ¶
func (s *ResetPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResetPasswordOutput ¶
type ResetPasswordOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPasswordResponse
func (ResetPasswordOutput) String ¶
func (s ResetPasswordOutput) String() string
String returns the string representation
type ResetPasswordRequest ¶
type ResetPasswordRequest struct { *aws.Request Input *ResetPasswordInput Copy func(*ResetPasswordInput) ResetPasswordRequest }
ResetPasswordRequest is the request type for the ResetPassword API operation.
func (ResetPasswordRequest) Send ¶
func (r ResetPasswordRequest) Send(ctx context.Context) (*ResetPasswordResponse, error)
Send marshals and sends the ResetPassword API request.
type ResetPasswordResponse ¶ added in v0.9.0
type ResetPasswordResponse struct { *ResetPasswordOutput // contains filtered or unexported fields }
ResetPasswordResponse is the response type for the ResetPassword API operation.
func (*ResetPasswordResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ResetPasswordResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ResetPassword request.
type Resource ¶
type Resource struct { // The date indicating when the resource was disabled from Amazon WorkMail use. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The email of the resource. Email *string `min:"1" type:"string"` // The date indicating when the resource was enabled for Amazon WorkMail use. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the resource. Id *string `min:"12" type:"string"` // The name of the resource. Name *string `min:"1" type:"string"` // The state of the resource, which can be ENABLED, DISABLED, or DELETED. State EntityState `type:"string" enum:"true"` // The type of the resource: equipment or room. Type ResourceType `type:"string" enum:"true"` // contains filtered or unexported fields }
The representation of a resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/Resource
type ResourceType ¶
type ResourceType string
const ( ResourceTypeRoom ResourceType = "ROOM" ResourceTypeEquipment ResourceType = "EQUIPMENT" )
Enum values for ResourceType
func (ResourceType) MarshalValue ¶ added in v0.3.0
func (enum ResourceType) MarshalValue() (string, error)
func (ResourceType) MarshalValueBuf ¶ added in v0.3.0
func (enum ResourceType) MarshalValueBuf(b []byte) ([]byte, error)
type UpdateMailboxQuotaInput ¶ added in v0.9.0
type UpdateMailboxQuotaInput struct { // The updated mailbox quota, in MB, for the specified user. // // MailboxQuota is a required field MailboxQuota *int64 `min:"1" type:"integer" required:"true"` // The identifier for the organization that contains the user for whom to update // the mailbox quota. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifer for the user for whom to update the mailbox quota. // // UserId is a required field UserId *string `min:"12" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuotaRequest
func (UpdateMailboxQuotaInput) String ¶ added in v0.9.0
func (s UpdateMailboxQuotaInput) String() string
String returns the string representation
func (*UpdateMailboxQuotaInput) Validate ¶ added in v0.9.0
func (s *UpdateMailboxQuotaInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMailboxQuotaOutput ¶ added in v0.9.0
type UpdateMailboxQuotaOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuotaResponse
func (UpdateMailboxQuotaOutput) String ¶ added in v0.9.0
func (s UpdateMailboxQuotaOutput) String() string
String returns the string representation
type UpdateMailboxQuotaRequest ¶ added in v0.9.0
type UpdateMailboxQuotaRequest struct { *aws.Request Input *UpdateMailboxQuotaInput Copy func(*UpdateMailboxQuotaInput) UpdateMailboxQuotaRequest }
UpdateMailboxQuotaRequest is the request type for the UpdateMailboxQuota API operation.
func (UpdateMailboxQuotaRequest) Send ¶ added in v0.9.0
func (r UpdateMailboxQuotaRequest) Send(ctx context.Context) (*UpdateMailboxQuotaResponse, error)
Send marshals and sends the UpdateMailboxQuota API request.
type UpdateMailboxQuotaResponse ¶ added in v0.9.0
type UpdateMailboxQuotaResponse struct { *UpdateMailboxQuotaOutput // contains filtered or unexported fields }
UpdateMailboxQuotaResponse is the response type for the UpdateMailboxQuota API operation.
func (*UpdateMailboxQuotaResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateMailboxQuotaResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateMailboxQuota request.
type UpdatePrimaryEmailAddressInput ¶
type UpdatePrimaryEmailAddressInput struct { // The value of the email to be updated as primary. // // Email is a required field Email *string `min:"1" type:"string" required:"true"` // The user, group, or resource to update. // // EntityId is a required field EntityId *string `min:"12" type:"string" required:"true"` // The organization that contains the user, group, or resource to update. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressRequest
func (UpdatePrimaryEmailAddressInput) String ¶
func (s UpdatePrimaryEmailAddressInput) String() string
String returns the string representation
func (*UpdatePrimaryEmailAddressInput) Validate ¶
func (s *UpdatePrimaryEmailAddressInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdatePrimaryEmailAddressOutput ¶
type UpdatePrimaryEmailAddressOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddressResponse
func (UpdatePrimaryEmailAddressOutput) String ¶
func (s UpdatePrimaryEmailAddressOutput) String() string
String returns the string representation
type UpdatePrimaryEmailAddressRequest ¶
type UpdatePrimaryEmailAddressRequest struct { *aws.Request Input *UpdatePrimaryEmailAddressInput Copy func(*UpdatePrimaryEmailAddressInput) UpdatePrimaryEmailAddressRequest }
UpdatePrimaryEmailAddressRequest is the request type for the UpdatePrimaryEmailAddress API operation.
func (UpdatePrimaryEmailAddressRequest) Send ¶
func (r UpdatePrimaryEmailAddressRequest) Send(ctx context.Context) (*UpdatePrimaryEmailAddressResponse, error)
Send marshals and sends the UpdatePrimaryEmailAddress API request.
type UpdatePrimaryEmailAddressResponse ¶ added in v0.9.0
type UpdatePrimaryEmailAddressResponse struct { *UpdatePrimaryEmailAddressOutput // contains filtered or unexported fields }
UpdatePrimaryEmailAddressResponse is the response type for the UpdatePrimaryEmailAddress API operation.
func (*UpdatePrimaryEmailAddressResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdatePrimaryEmailAddressResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdatePrimaryEmailAddress request.
type UpdateResourceInput ¶
type UpdateResourceInput struct { // The resource's booking options to be updated. BookingOptions *BookingOptions `type:"structure"` // The name of the resource to be updated. Name *string `min:"1" type:"string"` // The identifier associated with the organization for which the resource is // updated. // // OrganizationId is a required field OrganizationId *string `type:"string" required:"true"` // The identifier of the resource to be updated. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceRequest
func (UpdateResourceInput) String ¶
func (s UpdateResourceInput) String() string
String returns the string representation
func (*UpdateResourceInput) Validate ¶
func (s *UpdateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateResourceOutput ¶
type UpdateResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResourceResponse
func (UpdateResourceOutput) String ¶
func (s UpdateResourceOutput) String() string
String returns the string representation
type UpdateResourceRequest ¶
type UpdateResourceRequest struct { *aws.Request Input *UpdateResourceInput Copy func(*UpdateResourceInput) UpdateResourceRequest }
UpdateResourceRequest is the request type for the UpdateResource API operation.
func (UpdateResourceRequest) Send ¶
func (r UpdateResourceRequest) Send(ctx context.Context) (*UpdateResourceResponse, error)
Send marshals and sends the UpdateResource API request.
type UpdateResourceResponse ¶ added in v0.9.0
type UpdateResourceResponse struct { *UpdateResourceOutput // contains filtered or unexported fields }
UpdateResourceResponse is the response type for the UpdateResource API operation.
func (*UpdateResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateResource request.
type User ¶
type User struct { // The date indicating when the user was disabled from Amazon WorkMail use. DisabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The display name of the user. DisplayName *string `type:"string"` // The email of the user. Email *string `min:"1" type:"string"` // The date indicating when the user was enabled for Amazon WorkMail use. EnabledDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the user. Id *string `min:"12" type:"string"` // The name of the user. Name *string `min:"1" type:"string"` // The state of the user, which can be ENABLED, DISABLED, or DELETED. State EntityState `type:"string" enum:"true"` // The role of the user. UserRole UserRole `type:"string" enum:"true"` // contains filtered or unexported fields }
The representation of an Amazon WorkMail user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/User
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.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
- api_types.go
Directories ¶
Path | Synopsis |
---|---|
Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code.
|
Package workmailiface provides an interface to enable mocking the Amazon WorkMail service client for testing your code. |