amazonka-connect-2.0: Amazon Connect Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Connect.DescribeUser

Description

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Synopsis

Creating a Request

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser' 

Fields

  • userId :: Text

    The identifier of the user account.

  • instanceId :: Text

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details
ToHeaders DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

ToPath DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

ToQuery DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

AWSRequest DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Associated Types

type AWSResponse DescribeUser #

Generic DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Associated Types

type Rep DescribeUser :: Type -> Type #

Read DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Show DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

NFData DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Methods

rnf :: DescribeUser -> () #

Eq DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Hashable DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

type AWSResponse DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

type Rep DescribeUser Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.Connect.DescribeUser" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUser Source #

Create a value of DescribeUser 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:

DescribeUser, describeUser_userId - The identifier of the user account.

DescribeUser, describeUser_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

describeUser_userId :: Lens' DescribeUser Text Source #

The identifier of the user account.

describeUser_instanceId :: Lens' DescribeUser Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse' 

Fields

Instances

Instances details
Generic DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Associated Types

type Rep DescribeUserResponse :: Type -> Type #

Read DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Show DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

NFData DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

Methods

rnf :: DescribeUserResponse -> () #

Eq DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

type Rep DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Connect.DescribeUser

type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.Connect.DescribeUser" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeUserResponse Source #

Create a value of DescribeUserResponse 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:

DescribeUserResponse, describeUserResponse_user - Information about the user account and configuration settings.

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

Response Lenses

describeUserResponse_user :: Lens' DescribeUserResponse (Maybe User) Source #

Information about the user account and configuration settings.