Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Connect.CreateInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Synopsis

data CreateInstance = CreateInstance' {
- directoryId :: Maybe Text
- clientToken :: Maybe Text
- instanceAlias :: Maybe (Sensitive Text)
- identityManagementType :: DirectoryType
- inboundCallsEnabled :: Bool
- outboundCallsEnabled :: Bool
}
newCreateInstance :: DirectoryType -> Bool -> Bool -> CreateInstance
createInstance_directoryId :: Lens' CreateInstance (Maybe Text)
createInstance_clientToken :: Lens' CreateInstance (Maybe Text)
createInstance_instanceAlias :: Lens' CreateInstance (Maybe Text)
createInstance_identityManagementType :: Lens' CreateInstance DirectoryType
createInstance_inboundCallsEnabled :: Lens' CreateInstance Bool
createInstance_outboundCallsEnabled :: Lens' CreateInstance Bool
data CreateInstanceResponse = CreateInstanceResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- httpStatus :: Int
}
newCreateInstanceResponse :: Int -> CreateInstanceResponse
createInstanceResponse_arn :: Lens' CreateInstanceResponse (Maybe Text)
createInstanceResponse_id :: Lens' CreateInstanceResponse (Maybe Text)
createInstanceResponse_httpStatus :: Lens' CreateInstanceResponse Int

Creating a Request

data CreateInstance Source #

See: newCreateInstance smart constructor.

Constructors

CreateInstance'

Fields

directoryId :: Maybe Text
The identifier for the directory.
clientToken :: Maybe Text
The idempotency token.
instanceAlias :: Maybe (Sensitive Text)
The name for your instance.
identityManagementType :: DirectoryType
The type of identity management for your Amazon Connect users.
inboundCallsEnabled :: Bool
Your contact center handles incoming contacts.
outboundCallsEnabled :: Bool
Your contact center allows outbound calls.

Instances

Instances details

Eq CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods (==) :: CreateInstance -> CreateInstance -> Bool # (/=) :: CreateInstance -> CreateInstance -> Bool #
Show CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods showsPrec :: Int -> CreateInstance -> ShowS # show :: CreateInstance -> String # showList :: [CreateInstance] -> ShowS #
Generic CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Associated Types type Rep CreateInstance :: Type -> Type # Methods from :: CreateInstance -> Rep CreateInstance x # to :: Rep CreateInstance x -> CreateInstance #
NFData CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods rnf :: CreateInstance -> () #
Hashable CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods hashWithSalt :: Int -> CreateInstance -> Int # hash :: CreateInstance -> Int #
ToJSON CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods toJSON :: CreateInstance -> Value # toEncoding :: CreateInstance -> Encoding # toJSONList :: [CreateInstance] -> Value # toEncodingList :: [CreateInstance] -> Encoding #
AWSRequest CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Associated Types type AWSResponse CreateInstance # Methods request :: CreateInstance -> Request CreateInstance # response :: MonadResource m => Logger -> Service -> Proxy CreateInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateInstance))) #
ToHeaders CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods toHeaders :: CreateInstance -> [Header] #
ToPath CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods toPath :: CreateInstance -> ByteString #
ToQuery CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods toQuery :: CreateInstance -> QueryString #
type Rep CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance type Rep CreateInstance = D1 ('MetaData "CreateInstance" "Amazonka.Connect.CreateInstance" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "CreateInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "identityManagementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectoryType) :: (S1 ('MetaSel ('Just "inboundCallsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "outboundCallsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse CreateInstance Source #
Instance details Defined in Amazonka.Connect.CreateInstance type AWSResponse CreateInstance = CreateInstanceResponse

newCreateInstance Source #

Arguments

:: DirectoryType	`$sel:identityManagementType:CreateInstance'`
-> Bool	`$sel:inboundCallsEnabled:CreateInstance'`
-> Bool	`$sel:outboundCallsEnabled:CreateInstance'`
-> CreateInstance

Create a value of CreateInstance 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:directoryId:CreateInstance', createInstance_directoryId - The identifier for the directory.

$sel:clientToken:CreateInstance', createInstance_clientToken - The idempotency token.

$sel:instanceAlias:CreateInstance', createInstance_instanceAlias - The name for your instance.

$sel:identityManagementType:CreateInstance', createInstance_identityManagementType - The type of identity management for your Amazon Connect users.

$sel:inboundCallsEnabled:CreateInstance', createInstance_inboundCallsEnabled - Your contact center handles incoming contacts.

$sel:outboundCallsEnabled:CreateInstance', createInstance_outboundCallsEnabled - Your contact center allows outbound calls.

Request Lenses

createInstance_directoryId :: Lens' CreateInstance (Maybe Text) Source #

The identifier for the directory.

createInstance_clientToken :: Lens' CreateInstance (Maybe Text) Source #

The idempotency token.

createInstance_instanceAlias :: Lens' CreateInstance (Maybe Text) Source #

The name for your instance.

createInstance_identityManagementType :: Lens' CreateInstance DirectoryType Source #

The type of identity management for your Amazon Connect users.

createInstance_inboundCallsEnabled :: Lens' CreateInstance Bool Source #

Your contact center handles incoming contacts.

createInstance_outboundCallsEnabled :: Lens' CreateInstance Bool Source #

Your contact center allows outbound calls.

Destructuring the Response

data CreateInstanceResponse Source #

See: newCreateInstanceResponse smart constructor.

Constructors

CreateInstanceResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) of the instance. id :: Maybe Text The identifier for the instance. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods (==) :: CreateInstanceResponse -> CreateInstanceResponse -> Bool # (/=) :: CreateInstanceResponse -> CreateInstanceResponse -> Bool #
Read CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods readsPrec :: Int -> ReadS CreateInstanceResponse # readList :: ReadS [CreateInstanceResponse] # readPrec :: ReadPrec CreateInstanceResponse # readListPrec :: ReadPrec [CreateInstanceResponse] #
Show CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods showsPrec :: Int -> CreateInstanceResponse -> ShowS # show :: CreateInstanceResponse -> String # showList :: [CreateInstanceResponse] -> ShowS #
Generic CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance Associated Types type Rep CreateInstanceResponse :: Type -> Type # Methods from :: CreateInstanceResponse -> Rep CreateInstanceResponse x # to :: Rep CreateInstanceResponse x -> CreateInstanceResponse #
NFData CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance Methods rnf :: CreateInstanceResponse -> () #
type Rep CreateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.CreateInstance type Rep CreateInstanceResponse = D1 ('MetaData "CreateInstanceResponse" "Amazonka.Connect.CreateInstance" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "CreateInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateInstanceResponse'`
-> CreateInstanceResponse

Create a value of CreateInstanceResponse 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:arn:CreateInstanceResponse', createInstanceResponse_arn - The Amazon Resource Name (ARN) of the instance.

$sel:id:CreateInstanceResponse', createInstanceResponse_id - The identifier for the instance.

$sel:httpStatus:CreateInstanceResponse', createInstanceResponse_httpStatus - The response's http status code.

Response Lenses

createInstanceResponse_arn :: Lens' CreateInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance.

createInstanceResponse_id :: Lens' CreateInstanceResponse (Maybe Text) Source #

The identifier for the instance.

createInstanceResponse_httpStatus :: Lens' CreateInstanceResponse Int Source #

The response's http status code.