Connect / Client / describe_instance

describe_instance#

Connect.Client.describe_instance(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance(
    InstanceId='string'
)
Parameters:

InstanceId (string) –

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Return type:

dict

Returns:

Response Syntax

{
    'Instance': {
        'Id': 'string',
        'Arn': 'string',
        'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
        'InstanceAlias': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ServiceRole': 'string',
        'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
        'StatusReason': {
            'Message': 'string'
        },
        'InboundCallsEnabled': True|False,
        'OutboundCallsEnabled': True|False,
        'InstanceAccessUrl': 'string'
    }
}

Response Structure

  • (dict) –

    • Instance (dict) –

      The name of the instance.

      • Id (string) –

        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the instance.

      • IdentityManagementType (string) –

        The identity management type.

      • InstanceAlias (string) –

        The alias of instance.

      • CreatedTime (datetime) –

        When the instance was created.

      • ServiceRole (string) –

        The service role of the instance.

      • InstanceStatus (string) –

        The state of the instance.

      • StatusReason (dict) –

        Relevant details why the instance was not successfully created.

        • Message (string) –

          The message.

      • InboundCallsEnabled (boolean) –

        Whether inbound calls are enabled.

      • OutboundCallsEnabled (boolean) –

        Whether outbound calls are enabled.

      • InstanceAccessUrl (string) –

        This URL allows contact center users to access the Amazon Connect admin website.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException