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

Description

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Synopsis

Creating a Request

data DismissUserContact Source #

See: newDismissUserContact smart constructor.

Constructors

DismissUserContact' 

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.

  • contactId :: Text

    The identifier of the contact.

Instances

Instances details
ToJSON DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

ToHeaders DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

ToPath DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

ToQuery DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

AWSRequest DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Associated Types

type AWSResponse DismissUserContact #

Generic DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Associated Types

type Rep DismissUserContact :: Type -> Type #

Read DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Show DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

NFData DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Methods

rnf :: DismissUserContact -> () #

Eq DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Hashable DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

type AWSResponse DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

type Rep DismissUserContact Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

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

newDismissUserContact Source #

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

DismissUserContact, dismissUserContact_userId - The identifier of the user account.

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

DismissUserContact, dismissUserContact_contactId - The identifier of the contact.

Request Lenses

dismissUserContact_userId :: Lens' DismissUserContact Text Source #

The identifier of the user account.

dismissUserContact_instanceId :: Lens' DismissUserContact Text Source #

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

Destructuring the Response

data DismissUserContactResponse Source #

See: newDismissUserContactResponse smart constructor.

Constructors

DismissUserContactResponse' 

Fields

Instances

Instances details
Generic DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Associated Types

type Rep DismissUserContactResponse :: Type -> Type #

Read DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Show DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

NFData DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

Eq DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

type Rep DismissUserContactResponse Source # 
Instance details

Defined in Amazonka.Connect.DismissUserContact

type Rep DismissUserContactResponse = D1 ('MetaData "DismissUserContactResponse" "Amazonka.Connect.DismissUserContact" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DismissUserContactResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDismissUserContactResponse Source #

Create a value of DismissUserContactResponse 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:DismissUserContactResponse', dismissUserContactResponse_httpStatus - The response's http status code.

Response Lenses