list_artifacts async ¶

async def list_artifacts(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    branch_name: "capo_amplify.types.branch_name.BranchName",
    job_id: "capo_amplify.types.job_id.JobId",
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    next_token: Optional["capo_amplify.types.next_token.NextToken"] = None,
    max_results: Optional["capo_amplify.types.max_results.MaxResults"] = None,
) -> "capo_amplify.types.list_artifacts_result.ListArtifactsResult":
    """<p>Returns a list of end-to-end testing artifacts for a specified app, branch, and job.</p> <p>To return the build artifacts, use the <a href="https://docs.aws.amazon.com/amplify/latest/APIReference/API_GetJob.html">GetJob</a> API.</p> <p>For more information about Amplify testing support, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/running-tests.html">Setting up end-to-end Cypress tests for your Amplify application</a> in the <i>Amplify Hosting User Guide</i>. </p>

    Args:
        app_id: <p>The unique ID for an Amplify app. </p>
        branch_name: <p>The name of a branch that is part of an Amplify app. </p>
        job_id: <p>The unique ID for a job. </p>
        next_token: <p>A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. </p>
        max_results: <p>The maximum number of records to list in a single response. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.limit_exceeded_exception.LimitExceededException: <p>A resource could not be created because service quotas were exceeded. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplify.types.list_artifacts_request.ListArtifactsRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplify.types.list_artifacts_result.ListArtifactsResult"
    ]:
        import capo_amplify._operations.amplify.list_artifacts

        (
            output,
            http_response,
        ) = await capo_amplify._operations.amplify.list_artifacts.async_list_artifacts(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListArtifacts")
    )
    input_: capo_amplify.types.list_artifacts_request.ListArtifactsRequest = {
        "app_id": app_id,
        "branch_name": branch_name,
        "job_id": job_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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