VoiceID / Client / describe_fraudster_registration_job

describe_fraudster_registration_job#

VoiceID.Client.describe_fraudster_registration_job(**kwargs)#

Describes the specified fraudster registration job.

See also: AWS API Documentation

Request Syntax

response = client.describe_fraudster_registration_job(
    DomainId='string',
    JobId='string'
)
Parameters:

  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain that contains the fraudster registration job.

  • JobId (string) –

    [REQUIRED]

    The identifier of the fraudster registration job you are describing.

Return type:

dict

Returns:

Response Syntax

{
    'Job': {
        'CreatedAt': datetime(2015, 1, 1),
        'DataAccessRoleArn': 'string',
        'DomainId': 'string',
        'EndedAt': datetime(2015, 1, 1),
        'FailureDetails': {
            'Message': 'string',
            'StatusCode': 123
        },
        'InputDataConfig': {
            'S3Uri': 'string'
        },
        'JobId': 'string',
        'JobName': 'string',
        'JobProgress': {
            'PercentComplete': 123
        },
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
        'OutputDataConfig': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        },
        'RegistrationConfig': {
            'DuplicateRegistrationAction': 'SKIP'|'REGISTER_AS_NEW',
            'FraudsterSimilarityThreshold': 123,
            'WatchlistIds': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) –

    • Job (dict) –

      Contains details about the specified fraudster registration job.

      • CreatedAt (datetime) –

        A timestamp of when the fraudster registration job was created.

      • DataAccessRoleArn (string) –

        The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer’s buckets to read the input manifest file and write the job output file.

      • DomainId (string) –

        The identifier of the domain that contains the fraudster registration job.

      • EndedAt (datetime) –

        A timestamp of when the fraudster registration job ended.

      • FailureDetails (dict) –

        Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn’t fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

        • Message (string) –

          A description of the error that caused the batch job failure.

        • StatusCode (integer) –

          An HTTP status code representing the nature of the error.

      • InputDataConfig (dict) –

        The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.

        • S3Uri (string) –

          The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

      • JobId (string) –

        The service-generated identifier for the fraudster registration job.

      • JobName (string) –

        The client-provided name for the fraudster registration job.

      • JobProgress (dict) –

        Shows the completed percentage of registration requests listed in the input file.

        • PercentComplete (integer) –

          Shows the completed percentage of enrollment or registration requests listed in the input file.

      • JobStatus (string) –

        The current status of the fraudster registration job.

      • OutputDataConfig (dict) –

        The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.

        • KmsKeyId (string) –

          The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.

        • S3Uri (string) –

          The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.

      • RegistrationConfig (dict) –

        The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

        • DuplicateRegistrationAction (string) –

          The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.

        • FraudsterSimilarityThreshold (integer) –

          The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.

        • WatchlistIds (list) –

          The identifiers of watchlists that a fraudster is registered to. If a watchlist isn’t provided, the fraudsters are registered to the default watchlist.

          • (string) –

Exceptions