Connect / Client / list_evaluation_forms

list_evaluation_forms#

Connect.Client.list_evaluation_forms(**kwargs)#

Lists evaluation forms in the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_evaluation_forms(
    InstanceId='string',
    MaxResults=123,
    NextToken='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.

  • 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

{
    'EvaluationFormSummaryList': [
        {
            'EvaluationFormId': 'string',
            'EvaluationFormArn': 'string',
            'Title': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedBy': 'string',
            'LastActivatedTime': datetime(2015, 1, 1),
            'LastActivatedBy': 'string',
            'LatestVersion': 123,
            'ActiveVersion': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • EvaluationFormSummaryList (list) –

      Provides details about a list of evaluation forms belonging to an instance.

      • (dict) –

        Summary information about an evaluation form.

        • EvaluationFormId (string) –

          The unique identifier for the evaluation form.

        • EvaluationFormArn (string) –

          The Amazon Resource Name (ARN) for the evaluation form resource.

        • Title (string) –

          A title of the evaluation form.

        • CreatedTime (datetime) –

          The timestamp for when the evaluation form was created.

        • CreatedBy (string) –

          The Amazon Resource Name (ARN) of the user who created the evaluation form.

        • LastModifiedTime (datetime) –

          The timestamp for when the evaluation form was last updated.

        • LastModifiedBy (string) –

          The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

        • LastActivatedTime (datetime) –

          The timestamp for when the evaluation form was last activated.

        • LastActivatedBy (string) –

          The Amazon Resource Name (ARN) of the user who last activated the evaluation form.

        • LatestVersion (integer) –

          The version number of the latest evaluation form version.

        • ActiveVersion (integer) –

          The version of the active evaluation form version.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException