Skip to content

Describes an extraction definition in the specified Connect Customer instance

Description

Describes an extraction definition in the specified Connect Customer instance.

Usage

connect_describe_extraction_definition(InstanceId,
  ExtractionDefinitionId)

Arguments

  • InstanceId

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

  • ExtractionDefinitionId

[required] The identifier of the extraction definition to describe.

Value

A list with the following syntax:

list(
  ExtractionDefinition = list(
    Name = "string",
    ExtractionDefinitionId = "string",
    ExtractionDefinitionArn = "string",
    ExtractionConfiguration = list(
      PromptHint = "string",
      NotFoundBehavior = list(
        Behavior = "USE_DEFAULT_VALUE"|"OMIT",
        DefaultValue = "string"
      )
    ),
    Display = list(
      Label = "string"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedBy = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax

svc$describe_extraction_definition(
  InstanceId = "string",
  ExtractionDefinitionId = "string"
)