Struct aws_sdk_comprehend::operation::start_document_classification_job::StartDocumentClassificationJobOutput

#[non_exhaustive]
pub struct StartDocumentClassificationJobOutput {
    pub job_id: Option<String>,
    pub job_arn: Option<String>,
    pub job_status: Option<JobStatus>,
    pub document_classifier_arn: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_id: Option<String>

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

job_arn: Option<String>

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :document-classification-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

job_status: Option<JobStatus>

The status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

document_classifier_arn: Option<String>

The ARN of the custom classification model.

Implementations

impl StartDocumentClassificationJobOutput

pub fn job_id(&self) -> Option<&str>

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

pub fn job_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :document-classification-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

pub fn job_status(&self) -> Option<&JobStatus>

The status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

pub fn document_classifier_arn(&self) -> Option<&str>

The ARN of the custom classification model.

impl StartDocumentClassificationJobOutput

pub fn builder() -> StartDocumentClassificationJobOutputBuilder

Creates a new builder-style object to manufacture StartDocumentClassificationJobOutput.

Trait Implementations

impl Clone for StartDocumentClassificationJobOutput

fn clone(&self) -> StartDocumentClassificationJobOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartDocumentClassificationJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartDocumentClassificationJobOutput

fn eq(&self, other: &StartDocumentClassificationJobOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for StartDocumentClassificationJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for StartDocumentClassificationJobOutput