Skip to content

list_projects

list_projects(
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
    arn: Optional[AmazonResourceName] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListProjectsResult

Gets information about projects.

Parameters:

  • arn (Optional[AmazonResourceName], default: None ) –

    Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

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

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Raises:

Source code in docs_src/capo_device_farm/_services/device_farm.py
def list_projects(
    self,
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
    arn: Optional[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ] = None,
    next_token: Optional[
        "capo_device_farm.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_device_farm.types.list_projects_result.ListProjectsResult":
    """<p>Gets information about projects.</p>

    Args:
        arn: <p>Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.</p>
        next_token: <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.limit_exceeded_exception.LimitExceededException: <p>A limit was exceeded.</p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.service_account_exception.ServiceAccountException: <p>There was a problem with the service account.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_device_farm.types.list_projects_request.ListProjectsRequest]",
    ) -> OperationResponse[
        "capo_device_farm.types.list_projects_result.ListProjectsResult"
    ]:
        import capo_device_farm._operations.device_farm_20150623.list_projects

        output, http_response = (
            capo_device_farm._operations.device_farm_20150623.list_projects.list_projects(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProjects")
    )
    input_: capo_device_farm.types.list_projects_request.ListProjectsRequest = {}
    if arn is not None:
        input_["arn"] = arn
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output