ConnectWisdomService / Client / list_import_jobs

list_import_jobs#

ConnectWisdomService.Client.list_import_jobs(**kwargs)#

Lists information about import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_import_jobs(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • knowledgeBaseId (string) –

    [REQUIRED]

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'importJobSummaries': [
        {
            'createdTime': datetime(2015, 1, 1),
            'externalSourceConfiguration': {
                'configuration': {
                    'connectConfiguration': {
                        'instanceId': 'string'
                    }
                },
                'source': 'AMAZON_CONNECT'
            },
            'importJobId': 'string',
            'importJobType': 'QUICK_RESPONSES',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'lastModifiedTime': datetime(2015, 1, 1),
            'metadata': {
                'string': 'string'
            },
            'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'uploadId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • importJobSummaries (list) –

      Summary information about the import jobs.

      • (dict) –

        Summary information about the import job.

        • createdTime (datetime) –

          The timestamp when the import job was created.

        • externalSourceConfiguration (dict) –

          The configuration information of the external source that the resource data are imported from.

          • configuration (dict) –

            The configuration information of the external data source.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: connectConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • connectConfiguration (dict) –

              The configuration information of the Amazon Connect data source.

              • instanceId (string) –

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

          • source (string) –

            The type of the external data source.

        • importJobId (string) –

          The identifier of the import job.

        • importJobType (string) –

          The type of import job.

        • knowledgeBaseArn (string) –

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseId (string) –

          The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it.

        • lastModifiedTime (datetime) –

          The timestamp when the import job was last modified.

        • metadata (dict) –

          The metadata fields of the imported Wisdom resources.

          • (string) –

            • (string) –

        • status (string) –

          The status of the import job.

        • uploadId (string) –

          A pointer to the uploaded asset. This value is returned by StartContentUpload.

    • nextToken (string) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions