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

Description

Ends the specified contact. This call does not work for the following initiation methods:

  • DISCONNECT
  • TRANSFER
  • QUEUE_TRANSFER
Synopsis

Creating a Request

data StopContact Source #

See: newStopContact smart constructor.

Constructors

StopContact' 

Fields

  • contactId :: Text

    The ID of the contact.

  • instanceId :: Text

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

Instances

Instances details
ToJSON StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

ToHeaders StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Methods

toHeaders :: StopContact -> [Header] #

ToPath StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

ToQuery StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

AWSRequest StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Associated Types

type AWSResponse StopContact #

Generic StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Associated Types

type Rep StopContact :: Type -> Type #

Read StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Show StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

NFData StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Methods

rnf :: StopContact -> () #

Eq StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Hashable StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

type AWSResponse StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

type Rep StopContact Source # 
Instance details

Defined in Amazonka.Connect.StopContact

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

newStopContact Source #

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

StopContact, stopContact_contactId - The ID of the contact.

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

Request Lenses

stopContact_instanceId :: Lens' StopContact Text Source #

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

Destructuring the Response

data StopContactResponse Source #

See: newStopContactResponse smart constructor.

Constructors

StopContactResponse' 

Fields

Instances

Instances details
Generic StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Associated Types

type Rep StopContactResponse :: Type -> Type #

Read StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Show StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

NFData StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

Methods

rnf :: StopContactResponse -> () #

Eq StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

type Rep StopContactResponse Source # 
Instance details

Defined in Amazonka.Connect.StopContact

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

newStopContactResponse Source #

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

Response Lenses