Connect / Client / describe_prompt
describe_prompt#
- Connect.Client.describe_prompt(**kwargs)#
Describes the prompt.
See also: AWS API Documentation
Request Syntax
response = client.describe_prompt( InstanceId='string', PromptId='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.
PromptId (string) –
[REQUIRED]
A unique identifier for the prompt.
- Return type:
dict
- Returns:
Response Syntax
{ 'Prompt': { 'PromptARN': 'string', 'PromptId': 'string', 'Name': 'string', 'Description': 'string', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } }
Response Structure
(dict) –
Prompt (dict) –
Information about the prompt.
PromptARN (string) –
The Amazon Resource Name (ARN) of the prompt.
PromptId (string) –
A unique identifier for the prompt.
Name (string) –
The name of the prompt.
Description (string) –
The description of the prompt.
Tags (dict) –
The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
(string) –
(string) –
LastModifiedTime (datetime) –
The timestamp when this resource was last modified.
LastModifiedRegion (string) –
The Amazon Web Services Region where this resource was last modified.
Exceptions
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException