5.0.0 • Published 7 years ago

@datafire/amazonaws_workmail v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_workmail

Client library for Amazon WorkMail

Installation and Usage

npm install --save @datafire/amazonaws_workmail
let amazonaws_workmail = require('@datafire/amazonaws_workmail').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_workmail.AssociateDelegateToResource({
  "OrganizationId": "",
  "ResourceId": "",
  "EntityId": ""
}).then(data => {
  console.log(data);
});

Description

Actions

AssociateDelegateToResource

amazonaws_workmail.AssociateDelegateToResource({
  "OrganizationId": "",
  "ResourceId": "",
  "EntityId": ""
}, context)

Input

Output

AssociateMemberToGroup

amazonaws_workmail.AssociateMemberToGroup({
  "OrganizationId": "",
  "GroupId": "",
  "MemberId": ""
}, context)

Input

Output

CreateAlias

amazonaws_workmail.CreateAlias({
  "OrganizationId": "",
  "EntityId": "",
  "Alias": ""
}, context)

Input

Output

CreateGroup

amazonaws_workmail.CreateGroup({
  "OrganizationId": "",
  "Name": ""
}, context)

Input

Output

CreateResource

amazonaws_workmail.CreateResource({
  "OrganizationId": "",
  "Name": "",
  "Type": ""
}, context)

Input

Output

CreateUser

amazonaws_workmail.CreateUser({
  "OrganizationId": "",
  "Name": "",
  "DisplayName": "",
  "Password": ""
}, context)

Input

Output

DeleteAlias

amazonaws_workmail.DeleteAlias({
  "OrganizationId": "",
  "EntityId": "",
  "Alias": ""
}, context)

Input

Output

DeleteGroup

amazonaws_workmail.DeleteGroup({
  "OrganizationId": "",
  "GroupId": ""
}, context)

Input

Output

DeleteResource

amazonaws_workmail.DeleteResource({
  "OrganizationId": "",
  "ResourceId": ""
}, context)

Input

Output

DeleteUser

amazonaws_workmail.DeleteUser({
  "OrganizationId": "",
  "UserId": ""
}, context)

Input

Output

DeregisterFromWorkMail

amazonaws_workmail.DeregisterFromWorkMail({
  "OrganizationId": "",
  "EntityId": ""
}, context)

Input

Output

DescribeGroup

amazonaws_workmail.DescribeGroup({
  "OrganizationId": "",
  "GroupId": ""
}, context)

Input

Output

DescribeOrganization

amazonaws_workmail.DescribeOrganization({
  "OrganizationId": ""
}, context)

Input

Output

DescribeResource

amazonaws_workmail.DescribeResource({
  "OrganizationId": "",
  "ResourceId": ""
}, context)

Input

Output

DescribeUser

amazonaws_workmail.DescribeUser({
  "OrganizationId": "",
  "UserId": ""
}, context)

Input

Output

DisassociateDelegateFromResource

amazonaws_workmail.DisassociateDelegateFromResource({
  "OrganizationId": "",
  "ResourceId": "",
  "EntityId": ""
}, context)

Input

Output

DisassociateMemberFromGroup

amazonaws_workmail.DisassociateMemberFromGroup({
  "OrganizationId": "",
  "GroupId": "",
  "MemberId": ""
}, context)

Input

Output

ListAliases

amazonaws_workmail.ListAliases({
  "OrganizationId": "",
  "EntityId": ""
}, context)

Input

Output

ListGroupMembers

amazonaws_workmail.ListGroupMembers({
  "OrganizationId": "",
  "GroupId": ""
}, context)

Input

Output

ListGroups

amazonaws_workmail.ListGroups({
  "OrganizationId": ""
}, context)

Input

Output

ListOrganizations

amazonaws_workmail.ListOrganizations({}, context)

Input

Output

ListResourceDelegates

amazonaws_workmail.ListResourceDelegates({
  "OrganizationId": "",
  "ResourceId": ""
}, context)

Input

Output

ListResources

amazonaws_workmail.ListResources({
  "OrganizationId": ""
}, context)

Input

Output

ListUsers

amazonaws_workmail.ListUsers({
  "OrganizationId": ""
}, context)

Input

Output

RegisterToWorkMail

amazonaws_workmail.RegisterToWorkMail({
  "OrganizationId": "",
  "EntityId": "",
  "Email": ""
}, context)

Input

Output

ResetPassword

amazonaws_workmail.ResetPassword({
  "OrganizationId": "",
  "UserId": "",
  "Password": ""
}, context)

Input

Output

UpdatePrimaryEmailAddress

amazonaws_workmail.UpdatePrimaryEmailAddress({
  "OrganizationId": "",
  "EntityId": "",
  "Email": ""
}, context)

Input

Output

UpdateResource

amazonaws_workmail.UpdateResource({
  "OrganizationId": "",
  "ResourceId": ""
}, context)

Input

Output

Definitions

Aliases

AssociateDelegateToResourceRequest

AssociateDelegateToResourceResponse

  • AssociateDelegateToResourceResponse object

AssociateMemberToGroupRequest

AssociateMemberToGroupResponse

  • AssociateMemberToGroupResponse object

BookingOptions

  • BookingOptions object: At least one delegate must be associated to the resource to disable automatic replies from the resource.

Boolean

  • Boolean boolean

CreateAliasRequest

CreateAliasResponse

  • CreateAliasResponse object

CreateGroupRequest

CreateGroupResponse

CreateResourceRequest

CreateResourceResponse

  • CreateResourceResponse object

CreateUserRequest

CreateUserResponse

Delegate

  • Delegate object: The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

DeleteAliasRequest

DeleteAliasResponse

  • DeleteAliasResponse object

DeleteGroupRequest

DeleteGroupResponse

  • DeleteGroupResponse object

DeleteResourceRequest

DeleteResourceResponse

  • DeleteResourceResponse object

DeleteUserRequest

DeleteUserResponse

  • DeleteUserResponse object

DeregisterFromWorkMailRequest

DeregisterFromWorkMailResponse

  • DeregisterFromWorkMailResponse object

DescribeGroupRequest

DescribeGroupResponse

DescribeOrganizationRequest

  • DescribeOrganizationRequest object

DescribeOrganizationResponse

DescribeResourceRequest

DescribeResourceResponse

DescribeUserRequest

DescribeUserResponse

DirectoryServiceAuthenticationFailedException

  • DirectoryServiceAuthenticationFailedException object: The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.

DirectoryUnavailableException

  • DirectoryUnavailableException object: The directory that you are trying to perform operations on isn't available.

DisassociateDelegateFromResourceRequest

DisassociateDelegateFromResourceResponse

  • DisassociateDelegateFromResourceResponse object

DisassociateMemberFromGroupRequest

DisassociateMemberFromGroupResponse

  • DisassociateMemberFromGroupResponse object

EmailAddress

  • EmailAddress string

EmailAddressInUseException

  • EmailAddressInUseException object: The email address that you're trying to assign is already created for a different user, group, or resource.

EntityAlreadyRegisteredException

  • EntityAlreadyRegisteredException object: The user, group, or resource that you're trying to register is already registered.

EntityNotFoundException

  • EntityNotFoundException object: The identifier supplied for the entity is valid, but it does not exist in your organization.

EntityState

  • EntityState string (values: ENABLED, DISABLED, DELETED)

EntityStateException

  • EntityStateException object: You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted user.

Group

GroupName

  • GroupName string

Groups

InvalidConfigurationException

  • InvalidConfigurationException object: The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do it on its behalf.

InvalidParameterException

  • InvalidParameterException object: One or more of the input parameters don't match the service's restrictions.

InvalidPasswordException

  • InvalidPasswordException object: The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

ListAliasesRequest

ListAliasesResponse

ListGroupMembersRequest

ListGroupMembersResponse

ListGroupsRequest

ListGroupsResponse

ListOrganizationsRequest

ListOrganizationsResponse

ListResourceDelegatesRequest

ListResourceDelegatesResponse

ListResourcesRequest

ListResourcesResponse

ListUsersRequest

ListUsersResponse

MailDomainNotFoundException

  • MailDomainNotFoundException object: For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

MailDomainStateException

  • MailDomainStateException object: After a domain has been added to the organization, it must be verified. The domain is not yet verified.

MaxResults

  • MaxResults integer

Member

MemberType

  • MemberType string (values: GROUP, USER)

Members

NameAvailabilityException

  • NameAvailabilityException object: The entity (user, group, or user) name isn't unique in Amazon WorkMail.

NextToken

  • NextToken string

OrganizationId

  • OrganizationId string

OrganizationName

  • OrganizationName string

OrganizationNotFoundException

  • OrganizationNotFoundException object: An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException

  • OrganizationStateException object: The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

OrganizationSummaries

OrganizationSummary

Password

  • Password string

RegisterToWorkMailRequest

RegisterToWorkMailResponse

  • RegisterToWorkMailResponse object

ReservedNameException

  • ReservedNameException object: This entity name is not allowed in Amazon WorkMail.

ResetPasswordRequest

ResetPasswordResponse

  • ResetPasswordResponse object

Resource

ResourceDelegates

ResourceId

  • ResourceId string

ResourceName

  • ResourceName string

ResourceType

  • ResourceType string (values: ROOM, EQUIPMENT)

Resources

String

  • String string

Timestamp

  • Timestamp string

UnsupportedOperationException

  • UnsupportedOperationException object: You can't perform a write operation against a read-only directory.

UpdatePrimaryEmailAddressRequest

UpdatePrimaryEmailAddressResponse

  • UpdatePrimaryEmailAddressResponse object

UpdateResourceRequest

UpdateResourceResponse

  • UpdateResourceResponse object

User

UserName

  • UserName string

UserRole

  • UserRole string (values: USER, RESOURCE, SYSTEM_USER)

Users

  • Users array

WorkMailIdentifier

  • WorkMailIdentifier string
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago