Skip to content

describe_export_tasks async

describe_export_tasks(
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
    export_ids: Optional[ExportIds] = None,
    filters: Optional[ExportFilters] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeExportTasksResponse

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

Parameters:

  • export_ids (Optional[ExportIds], default: None ) –

    One or more unique identifiers used to query the status of an export request.

  • filters (Optional[ExportFilters], default: None ) –

    One or more filters.

    • AgentId - ID of the agent whose collected data will be exported

  • max_results (Optional[Integer], default: None ) –

    The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

  • next_token (Optional[NextToken], default: None ) –

    The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Raises:

Source code in docs_src/capo_application_discovery_service/_services/async_application_discovery_service.py
async def describe_export_tasks(
    self,
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
    export_ids: Optional[
        "capo_application_discovery_service.types.export_ids.ExportIds"
    ] = None,
    filters: Optional[
        "capo_application_discovery_service.types.export_filters.ExportFilters"
    ] = None,
    max_results: Optional[
        "capo_application_discovery_service.types.integer.Integer"
    ] = None,
    next_token: Optional[
        "capo_application_discovery_service.types.next_token.NextToken"
    ] = None,
) -> "capo_application_discovery_service.types.describe_export_tasks_response.DescribeExportTasksResponse":
    """<p>Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.</p>

    Args:
        export_ids: <p>One or more unique identifiers used to query the status of an export request.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>AgentId</code> - ID of the agent whose collected data will be exported</p> </li> </ul>
        max_results: <p>The maximum number of volume results returned by <code>DescribeExportTasks</code> in paginated output. When this parameter is used, <code>DescribeExportTasks</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element.</p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeExportTasks</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p>

    Raises:
        capo_application_discovery_service.errors.authorization_error_exception.AuthorizationErrorException: <p>The user does not have permission to perform the action. Check the IAM policy associated with this user.</p>
        capo_application_discovery_service.errors.home_region_not_set_exception.HomeRegionNotSetException: <p>The home Region is not set. Set the home Region to continue.</p>
        capo_application_discovery_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid. Verify the parameters and try again.</p>
        capo_application_discovery_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.</p>
        capo_application_discovery_service.errors.server_internal_error_exception.ServerInternalErrorException: <p>The server experienced an internal error. Try again.</p>
        capo_application_discovery_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_application_discovery_service.types.describe_export_tasks_request.DescribeExportTasksRequest]",
    ) -> AsyncOperationResponse[
        "capo_application_discovery_service.types.describe_export_tasks_response.DescribeExportTasksResponse"
    ]:
        import capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.describe_export_tasks

        (
            output,
            http_response,
        ) = await capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.describe_export_tasks.async_describe_export_tasks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeExportTasks")
    )
    input_: capo_application_discovery_service.types.describe_export_tasks_request.DescribeExportTasksRequest = {}
    if export_ids is not None:
        input_["export_ids"] = export_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output