Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.
Parameters:
-
catalog
(CatalogIdentifier)
–
Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.
-
task_identifier
(ProspectingTaskIdentifier)
–
The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.
Raises:
-
AccessDeniedException
–
This error occurs when you don't have permission to perform the requested action.
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
-
InternalServerException
–
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.
-
ResourceNotFoundException
–
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.
-
ThrottlingException
–
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.
This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.
-
ValidationException
–
The input fails to satisfy the constraints specified by the service or business validation rules.
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_partnercentral_selling/_services/partner_central_selling.py
| def get_prospecting_from_engagement_task(
self,
catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
task_identifier: "capo_partnercentral_selling.types.prospecting_task_identifier.ProspectingTaskIdentifier",
*,
config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
) -> "capo_partnercentral_selling.types.get_prospecting_from_engagement_task_response.GetProspectingFromEngagementTaskResponse":
"""<p>Retrieves the details and current status of a prospecting task previously started with <code>StartProspectingFromEngagementTask</code> to enable polling for completion and access to per-engagement processing results.</p>
Args:
catalog: <p>Specifies the catalog associated with the task. Specify <code>AWS</code> for production environments and <code>Sandbox</code> for testing and development purposes. The value must match the catalog used when the task was created.</p>
task_identifier: <p>The unique identifier of the prospecting task to retrieve. This value is returned in the <code>TaskId</code> field of the <code>StartProspectingFromEngagementTask</code> response.</p>
Raises:
capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_partnercentral_selling.types.get_prospecting_from_engagement_task_request.GetProspectingFromEngagementTaskRequest]",
) -> OperationResponse[
"capo_partnercentral_selling.types.get_prospecting_from_engagement_task_response.GetProspectingFromEngagementTaskResponse"
]:
import capo_partnercentral_selling._operations.aws_partner_central_selling.get_prospecting_from_engagement_task
output, http_response = (
capo_partnercentral_selling._operations.aws_partner_central_selling.get_prospecting_from_engagement_task.get_prospecting_from_engagement_task(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetProspectingFromEngagementTask")
)
input_: capo_partnercentral_selling.types.get_prospecting_from_engagement_task_request.GetProspectingFromEngagementTaskRequest = {
"catalog": catalog,
"task_identifier": task_identifier,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|