Assured Workloads API . projects . locations . dbFrameworkComplianceReports

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

Gets the aggregated compliance report over time for a given scope.

Args:
  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
  filter: string, Optional. The filtering results.
  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 list of aggregated compliance reports.
    { # The aggregated compliance report.
      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of 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.
      },
      "reportTime": "A String", # The report time of the aggregated compliance report.
    },
  ],
}

close()

Close httplib2 connections.

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

Fetches the framework compliance report for a given scope.

Args:
  name: string, Required. The name of the framework compliance report to retrieve. (required)
  endTime: string, Optional. The end time of the report.
  filter: string, Optional. The filtering results.
  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 control assessment details of 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 name of the framework.
  "frameworkCategories": [ # The list of framework categories supported.
    "A String",
  ],
  "frameworkDescription": "A String", # The description of the framework.
  "frameworkDisplayName": "A String", # Optional. The display name for 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 name of the framework compliance report.
  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
    "A String",
  ],
  "targetResourceDetails": [ # The target resource details of the framework.
    { # 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 last updated time of the report.
}