libZSservicesZSamazonka-workmailZSamazonka-workmail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkMail.RegisterToWorkMail

Description

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

Synopsis

Creating a Request

data RegisterToWorkMail Source #

See: newRegisterToWorkMail smart constructor.

Constructors

RegisterToWorkMail' 

Fields

  • organizationId :: Text

    The identifier for the organization under which the user, group, or resource exists.

  • entityId :: Text

    The identifier for the user, group, or resource to be updated.

  • email :: Text

    The email for the user, group, or resource to be updated.

Instances

Instances details
Eq RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Read RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Show RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Generic RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Associated Types

type Rep RegisterToWorkMail :: Type -> Type #

NFData RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Methods

rnf :: RegisterToWorkMail -> () #

Hashable RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

ToJSON RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

AWSRequest RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Associated Types

type AWSResponse RegisterToWorkMail #

ToHeaders RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

ToPath RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

ToQuery RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

type Rep RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

type Rep RegisterToWorkMail = D1 ('MetaData "RegisterToWorkMail" "Amazonka.WorkMail.RegisterToWorkMail" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "RegisterToWorkMail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterToWorkMail Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

newRegisterToWorkMail Source #

Create a value of RegisterToWorkMail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationId:RegisterToWorkMail', registerToWorkMail_organizationId - The identifier for the organization under which the user, group, or resource exists.

$sel:entityId:RegisterToWorkMail', registerToWorkMail_entityId - The identifier for the user, group, or resource to be updated.

$sel:email:RegisterToWorkMail', registerToWorkMail_email - The email for the user, group, or resource to be updated.

Request Lenses

registerToWorkMail_organizationId :: Lens' RegisterToWorkMail Text Source #

The identifier for the organization under which the user, group, or resource exists.

registerToWorkMail_entityId :: Lens' RegisterToWorkMail Text Source #

The identifier for the user, group, or resource to be updated.

registerToWorkMail_email :: Lens' RegisterToWorkMail Text Source #

The email for the user, group, or resource to be updated.

Destructuring the Response

data RegisterToWorkMailResponse Source #

See: newRegisterToWorkMailResponse smart constructor.

Constructors

RegisterToWorkMailResponse' 

Fields

Instances

Instances details
Eq RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Read RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Show RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Generic RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

Associated Types

type Rep RegisterToWorkMailResponse :: Type -> Type #

NFData RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

type Rep RegisterToWorkMailResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterToWorkMail

type Rep RegisterToWorkMailResponse = D1 ('MetaData "RegisterToWorkMailResponse" "Amazonka.WorkMail.RegisterToWorkMail" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "RegisterToWorkMailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterToWorkMailResponse Source #

Create a value of RegisterToWorkMailResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RegisterToWorkMailResponse', registerToWorkMailResponse_httpStatus - The response's http status code.

Response Lenses