Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
Parameters:
-
batch_segment_job_arn
(Arn)
–
The ARN of the batch segment job to describe.
Raises:
Source code in docs_src/capo_personalize/_services/personalize.py
| def describe_batch_segment_job(
self,
batch_segment_job_arn: "capo_personalize.types.arn.Arn",
*,
config_overrides: Optional[PersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_batch_segment_job_response.DescribeBatchSegmentJobResponse":
"""<p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.</p>
Args:
batch_segment_job_arn: <p>The ARN of the batch segment job to describe.</p>
Raises:
capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_personalize.types.describe_batch_segment_job_request.DescribeBatchSegmentJobRequest]",
) -> OperationResponse[
"capo_personalize.types.describe_batch_segment_job_response.DescribeBatchSegmentJobResponse"
]:
import capo_personalize._operations.amazon_personalize.describe_batch_segment_job
output, http_response = (
capo_personalize._operations.amazon_personalize.describe_batch_segment_job.describe_batch_segment_job(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeBatchSegmentJob")
)
input_: capo_personalize.types.describe_batch_segment_job_request.DescribeBatchSegmentJobRequest = {
"batch_segment_job_arn": batch_segment_job_arn
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|