Skip to content

list_artifacts async

list_artifacts(
    agent_space_id: AgentSpaceId,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListArtifactsOutput

Returns a paginated list of artifact summaries for the specified agent space.

Parameters:

  • agent_space_id (AgentSpaceId) –

    The unique identifier of the agent space to list artifacts for.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

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

    The maximum number of results to return in a single call.

Raises:

Source code in docs_src/capo_securityagent/_services/async_security_agent.py
async def list_artifacts(
    self,
    agent_space_id: "capo_securityagent.types.agent_space_id.AgentSpaceId",
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    next_token: Optional["capo_securityagent.types.next_token.NextToken"] = None,
    max_results: Optional["capo_securityagent.types.max_results.MaxResults"] = None,
) -> "capo_securityagent.types.list_artifacts_output.ListArtifactsOutput":
    """<p>Returns a paginated list of artifact summaries for the specified agent space.</p>

    Args:
        agent_space_id: <p>The unique identifier of the agent space to list artifacts for.</p>
        next_token: <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>

    Raises:
        capo_securityagent.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_securityagent.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of your request.</p>
        capo_securityagent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
        capo_securityagent.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_securityagent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_securityagent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityagent.types.list_artifacts_input.ListArtifactsInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.list_artifacts_output.ListArtifactsOutput"
    ]:
        import capo_securityagent._operations.security_agent.list_artifacts

        (
            output,
            http_response,
        ) = await capo_securityagent._operations.security_agent.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_securityagent.types.list_artifacts_input.ListArtifactsInput = {
        "agent_space_id": agent_space_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