Assured Workloads API . organizations . locations . dbFrameworkComplianceReports

aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.

Args:
  name: string, Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
  filter: string, Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).
  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for AggregateDbFrameworkComplianceReport.
  "aggregatedComplianceReports": [ # The daily compliance reports for the requested time range.
    { # A point-in-time compliance report for a framework.
      "controlAssessmentDetails": { # The details for a control assessment. # The number of passing, failing, and not assessed controls in the framework at `report_time`.
        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
          "A String",
        ],
        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
        "failingControlIds": [ # The list of controls that are failing.
          "A String",
        ],
        "failingControls": 42, # The number of controls that are failing.
        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
          "A String",
        ],
        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
        "passingControlIds": [ # The list of controls that are passing or not assessed.
          "A String",
        ],
        "passingControls": 42, # The number of controls that are passing or not assessed.
      },
      "reportTime": "A String", # The time that the compliance report represents.
    },
  ],
}

close()

Close httplib2 connections.

fetch(name, endTime=None, filter=None, x__xgafv=None)

Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.

Args:
  name: string, Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
  endTime: string, Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.
  filter: string, Optional. A filter expression that restricts the results. Reserved for future use.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for FetchDbFrameworkComplianceReport.
  "controlAssessmentDetails": { # The details for a control assessment. # The number of passing, failing, and not assessed controls in the framework.
    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
      "A String",
    ],
    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
    "failingControlIds": [ # The list of controls that are failing.
      "A String",
    ],
    "failingControls": 42, # The number of controls that are failing.
    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
      "A String",
    ],
    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
    "passingControlIds": [ # The list of controls that are passing or not assessed.
      "A String",
    ],
    "passingControls": 42, # The number of controls that are passing or not assessed.
  },
  "framework": "A String", # The resource name of the compliance framework. For example, `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.
  "frameworkCategories": [ # The categories of the framework.
    "A String",
  ],
  "frameworkDescription": "A String", # The description of the framework.
  "frameworkDisplayName": "A String", # Optional. The display name of the framework.
  "frameworkType": "A String", # The type of the framework.
  "majorRevisionId": "A String", # The latest major revision ID of the framework.
  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
  "name": "A String", # The resource name of the framework compliance report.
  "supportedCloudProviders": [ # The cloud providers that are supported by the framework.
    "A String",
  ],
  "targetResourceDetails": [ # The details of the target resources (organizations, folders, or projects) that the framework is deployed on.
    { # The details for a target resource.
      "createTime": "A String", # The create time of the target resource.
      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
      "updateTime": "A String", # The update time of the target resource.
    },
  ],
  "updateTime": "A String", # Output only. The time when the report was last updated.
}