Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.ReplicateInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

Synopsis

data ReplicateInstance = ReplicateInstance' {
- clientToken :: Maybe Text
- instanceId :: Text
- replicaRegion :: Text
- replicaAlias :: Sensitive Text
}
newReplicateInstance :: Text -> Text -> Text -> ReplicateInstance
replicateInstance_clientToken :: Lens' ReplicateInstance (Maybe Text)
replicateInstance_instanceId :: Lens' ReplicateInstance Text
replicateInstance_replicaRegion :: Lens' ReplicateInstance Text
replicateInstance_replicaAlias :: Lens' ReplicateInstance Text
data ReplicateInstanceResponse = ReplicateInstanceResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- httpStatus :: Int
}
newReplicateInstanceResponse :: Int -> ReplicateInstanceResponse
replicateInstanceResponse_arn :: Lens' ReplicateInstanceResponse (Maybe Text)
replicateInstanceResponse_id :: Lens' ReplicateInstanceResponse (Maybe Text)
replicateInstanceResponse_httpStatus :: Lens' ReplicateInstanceResponse Int

Creating a Request

data ReplicateInstance Source #

See: newReplicateInstance smart constructor.

Constructors

ReplicateInstance'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.
replicaRegion :: Text
The Amazon Web Services Region where to replicate the Amazon Connect instance.
replicaAlias :: Sensitive Text
The alias for the replicated instance. The ReplicaAlias must be unique.

Instances

Instances details

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

newReplicateInstance Source #

Arguments

:: Text	`ReplicateInstance`
-> Text	`$sel:replicaRegion:ReplicateInstance'`
-> Text	`$sel:replicaAlias:ReplicateInstance'`
-> ReplicateInstance

Create a value of ReplicateInstance 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:clientToken:ReplicateInstance', replicateInstance_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

ReplicateInstance, replicateInstance_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

$sel:replicaRegion:ReplicateInstance', replicateInstance_replicaRegion - The Amazon Web Services Region where to replicate the Amazon Connect instance.

$sel:replicaAlias:ReplicateInstance', replicateInstance_replicaAlias - The alias for the replicated instance. The ReplicaAlias must be unique.

Request Lenses

replicateInstance_clientToken :: Lens' ReplicateInstance (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

replicateInstance_instanceId :: Lens' ReplicateInstance Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

replicateInstance_replicaRegion :: Lens' ReplicateInstance Text Source #

The Amazon Web Services Region where to replicate the Amazon Connect instance.

replicateInstance_replicaAlias :: Lens' ReplicateInstance Text Source #

The alias for the replicated instance. The ReplicaAlias must be unique.

Destructuring the Response

data ReplicateInstanceResponse Source #

See: newReplicateInstanceResponse smart constructor.

Constructors

ReplicateInstanceResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) of the replicated instance. id :: Maybe Text The identifier of the replicated instance. You can find the `instanceId` in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance Associated Types type Rep ReplicateInstanceResponse :: Type -> Type # Methods from :: ReplicateInstanceResponse -> Rep ReplicateInstanceResponse x # to :: Rep ReplicateInstanceResponse x -> ReplicateInstanceResponse #
Read ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance Methods readsPrec :: Int -> ReadS ReplicateInstanceResponse # readList :: ReadS [ReplicateInstanceResponse] # readPrec :: ReadPrec ReplicateInstanceResponse # readListPrec :: ReadPrec [ReplicateInstanceResponse] #
Show ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance Methods showsPrec :: Int -> ReplicateInstanceResponse -> ShowS # show :: ReplicateInstanceResponse -> String # showList :: [ReplicateInstanceResponse] -> ShowS #
NFData ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance Methods rnf :: ReplicateInstanceResponse -> () #
Eq ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance Methods (==) :: ReplicateInstanceResponse -> ReplicateInstanceResponse -> Bool # (/=) :: ReplicateInstanceResponse -> ReplicateInstanceResponse -> Bool #
type Rep ReplicateInstanceResponse Source #
Instance details Defined in Amazonka.Connect.ReplicateInstance type Rep ReplicateInstanceResponse = D1 ('MetaData "ReplicateInstanceResponse" "Amazonka.Connect.ReplicateInstance" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ReplicateInstanceResponse'" '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))))

newReplicateInstanceResponse Source #

Arguments

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

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

ReplicateInstanceResponse, replicateInstanceResponse_arn - The Amazon Resource Name (ARN) of the replicated instance.

ReplicateInstanceResponse, replicateInstanceResponse_id - The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

$sel:httpStatus:ReplicateInstanceResponse', replicateInstanceResponse_httpStatus - The response's http status code.

Response Lenses

replicateInstanceResponse_arn :: Lens' ReplicateInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the replicated instance.

replicateInstanceResponse_id :: Lens' ReplicateInstanceResponse (Maybe Text) Source #

The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

replicateInstanceResponse_httpStatus :: Lens' ReplicateInstanceResponse Int Source #

The response's http status code.