

# Reading from CircleCI entities
<a name="circleci-reading-from-entities"></a>

**Prerequisite**

A CircleCI object you would like to read from. You will need the object name.

**Supported entities for source**:


| Entity | Can be filtered | Supports limit | Supports Order by | Supports Select \$1 | Supports partitioning | 
| --- | --- | --- | --- | --- | --- | 
| Context | Yes | No | No | Yes | No | 
| Organization Summary Metric | Yes | No | No | Yes | No | 
| Pipeline | No | No | No | Yes | No | 
| Pipeline Workflow | Yes | No | No | Yes | No | 
| Project Branch | Yes | No | No | Yes | No | 
| Project Flaky Test | No | No | No | Yes | No | 
| Project Summary Metric | Yes | No | No | Yes | No | 
| Schedule | No | No | No | Yes | No | 
| Workflow Job Timeseries | Yes | No | No | Yes | No | 
| Workflow Metric And Trend | Yes | No | No | Yes | No | 
| Workflow Recent Run | Yes | No | No | Yes | No | 
| Workflow Summary Metric | Yes | No | No | Yes | No | 
| Workflow Test Metric | Yes | No | No | Yes | No | 

**Example**:

```
circleci_read = glueContext.create_dynamic_frame.from_options(
    connection_type="circleci",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "context/e7ea2945-dccb-4205-b673-8391fe1b3a4c",
        "API_VERSION": "v2"
    }
```

## CircleCI entity and field details
<a name="circleci-reading-from-entities-field-details"></a>

For more information about the entities and field details see:
+ [Contexts](https://circleci.com/docs/api/v2/#operation/listContexts)
+ [Project Summary Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowsPageData)
+ [Workflow Job Timeseries](https://circleci.com/docs/api/v2/#operation/getJobTimeseries)
+ [Organization Summary Metrics](https://circleci.com/docs/api/v2/#operation/getOrgSummaryData)
+ [Project Branches](https://circleci.com/docs/api/v2/#operation/getAllInsightsBranches)
+ [Project Flaky Tests](https://circleci.com/docs/api/v2/#operation/getFlakyTests)
+ [Workflow Recent Runs](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowRuns)
+ [Workflow Summary Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowMetrics)
+ [Workflow Metrics and Trends](https://circleci.com/docs/api/v2/#operation/getWorkflowSummary)
+ [Workflow Test Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowTestMetrics)
+ [Pipelines](https://circleci.com/docs/api/v2/#operation/listPipelinesForProject)
+ [Pipeline Workflows](https://circleci.com/docs/api/v2/#operation/listWorkflowsByPipelineId)
+ [Schedules](https://circleci.com/docs/api/v2/#operation/listSchedulesForProject)

Entities with static metadata:

[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/glue/latest/dg/circleci-reading-from-entities.html)

**Note**  
Struct and List data types are converted to String data type in the response of the connector.

**Partitioning queries**

CircleCI doesn’t support field-based or record-based partitioning.