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

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.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Creating a Request

data DescribeInstance Source #

See: newDescribeInstance smart constructor.

Constructors

DescribeInstance'
Fields instanceId :: Text The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

Eq DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods (==) :: DescribeInstance -> DescribeInstance -> Bool # (/=) :: DescribeInstance -> DescribeInstance -> Bool #
Read DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods readsPrec :: Int -> ReadS DescribeInstance # readList :: ReadS [DescribeInstance] # readPrec :: ReadPrec DescribeInstance # readListPrec :: ReadPrec [DescribeInstance] #
Show DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods showsPrec :: Int -> DescribeInstance -> ShowS # show :: DescribeInstance -> String # showList :: [DescribeInstance] -> ShowS #
Generic DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Associated Types type Rep DescribeInstance :: Type -> Type # Methods from :: DescribeInstance -> Rep DescribeInstance x # to :: Rep DescribeInstance x -> DescribeInstance #
NFData DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods rnf :: DescribeInstance -> () #
Hashable DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods hashWithSalt :: Int -> DescribeInstance -> Int # hash :: DescribeInstance -> Int #
AWSRequest DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Associated Types type AWSResponse DescribeInstance # Methods request :: DescribeInstance -> Request DescribeInstance # response :: MonadResource m => Logger -> Service -> Proxy DescribeInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInstance))) #
ToHeaders DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods toHeaders :: DescribeInstance -> [Header] #
ToPath DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods toPath :: DescribeInstance -> ByteString #
ToQuery DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods toQuery :: DescribeInstance -> QueryString #
type Rep DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance type Rep DescribeInstance = D1 ('MetaData "DescribeInstance" "Amazonka.Connect.DescribeInstance" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "DescribeInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeInstance Source #
Instance details Defined in Amazonka.Connect.DescribeInstance type AWSResponse DescribeInstance = DescribeInstanceResponse

newDescribeInstance Source #

Arguments

:: Text	`$sel:instanceId:DescribeInstance'`
-> DescribeInstance

Create a value of DescribeInstance 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:instanceId:DescribeInstance', describeInstance_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

describeInstance_instanceId :: Lens' DescribeInstance Text Source #

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

Destructuring the Response

data DescribeInstanceResponse Source #

See: newDescribeInstanceResponse smart constructor.

Constructors

DescribeInstanceResponse'
Fields instance' :: Maybe Instance The name of the instance. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeInstanceResponse Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods (==) :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool # (/=) :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool #
Show DescribeInstanceResponse Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods showsPrec :: Int -> DescribeInstanceResponse -> ShowS # show :: DescribeInstanceResponse -> String # showList :: [DescribeInstanceResponse] -> ShowS #
Generic DescribeInstanceResponse Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Associated Types type Rep DescribeInstanceResponse :: Type -> Type # Methods from :: DescribeInstanceResponse -> Rep DescribeInstanceResponse x # to :: Rep DescribeInstanceResponse x -> DescribeInstanceResponse #
NFData DescribeInstanceResponse Source #
Instance details Defined in Amazonka.Connect.DescribeInstance Methods rnf :: DescribeInstanceResponse -> () #
type Rep DescribeInstanceResponse Source #
Instance details Defined in Amazonka.Connect.DescribeInstance type Rep DescribeInstanceResponse = D1 ('MetaData "DescribeInstanceResponse" "Amazonka.Connect.DescribeInstance" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "DescribeInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instance'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Instance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeInstanceResponse Source #

Arguments

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

Create a value of DescribeInstanceResponse 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:instance':DescribeInstanceResponse', describeInstanceResponse_instance - The name of the instance.

$sel:httpStatus:DescribeInstanceResponse', describeInstanceResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceResponse_instance :: Lens' DescribeInstanceResponse (Maybe Instance) Source #

The name of the instance.

describeInstanceResponse_httpStatus :: Lens' DescribeInstanceResponse Int Source #

The response's http status code.