Struct aws_sdk_comprehend::client::fluent_builders::StartTopicsDetectionJob [−][src]
pub struct StartTopicsDetectionJob<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to StartTopicsDetectionJob
.
Starts an asynchronous topic detection job. Use the
DescribeTopicDetectionJob
operation to track the status of a job.
Implementations
impl<C, M, R> StartTopicsDetectionJob<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> StartTopicsDetectionJob<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<StartTopicsDetectionJobOutput, SdkError<StartTopicsDetectionJobError>> where
R::Policy: SmithyRetryPolicy<StartTopicsDetectionJobInputOperationOutputAlias, StartTopicsDetectionJobOutput, StartTopicsDetectionJobError, StartTopicsDetectionJobInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<StartTopicsDetectionJobOutput, SdkError<StartTopicsDetectionJobError>> where
R::Policy: SmithyRetryPolicy<StartTopicsDetectionJobInputOperationOutputAlias, StartTopicsDetectionJobOutput, StartTopicsDetectionJobError, StartTopicsDetectionJobInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Specifies the format and location of the input data for the job.
Specifies the format and location of the input data for the job.
Specifies where to send the output files. The output is a compressed archive with two
files, topic-terms.csv
that lists the terms associated with each topic, and
doc-topics.csv
that lists the documents associated with each topic
Specifies where to send the output files. The output is a compressed archive with two
files, topic-terms.csv
that lists the terms associated with each topic, and
doc-topics.csv
that lists the documents associated with each topic
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
The identifier of the job.
The number of topics to detect.
The number of topics to detect.
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for StartTopicsDetectionJob<C, M, R>
impl<C, M, R> Send for StartTopicsDetectionJob<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for StartTopicsDetectionJob<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for StartTopicsDetectionJob<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for StartTopicsDetectionJob<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more