analyzeWorkloadMove(target, assetTypes=None, pageSize=None, pageToken=None, project=None, x__xgafv=None)

Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.

Args:
  target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
  assetTypes: string, Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). (repeated)
  pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used.
  pageToken: string, Optional. The page token from the previous response. It needs to be passed in the second and following requests.
  project: string, The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response containing the analysis results for the hypothetical resource move.
  "assetMoveAnalyses": [ # List of analysis results for each asset in scope.
    { # Represents move analysis results for an asset.
      "analysisGroups": [ # List of eligible analyses performed for the asset.
        { # Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.
          "analysisResult": { # Represents the successful move analysis results for a group. # Result of a successful analysis.
            "blockers": [ # List of blockers. If not resolved, these will result in compliance violations in the target.
              { # Represents the impact of moving the asset to the target.
                "detail": "A String", # Explanation of the impact.
              },
            ],
            "warnings": [ # List of warnings. These are risks that may or may not result in compliance violations.
              { # Represents the impact of moving the asset to the target.
                "detail": "A String", # Explanation of the impact.
              },
            ],
          },
          "displayName": "A String", # Name of the analysis group.
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Error details for a failed analysis.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
        },
      ],
      "asset": "A String", # The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1
      "assetType": "A String", # Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
    },
  ],
  "nextPageToken": "A String", # The next page token. Is empty if the last page is reached.
}

analyzeWorkloadMove_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

close()

Close httplib2 connections.

create(parent, body=None, externalId=None, x__xgafv=None)

Creates Assured Workload.

Args:
parent: string, Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. (required)
body: object, The request body.
The object takes the form of:

{ # A Workload object for managing highly regulated workloads of cloud customers.
"availableUpdates": 42, # Output only. The number of updates available for the workload.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedResourceViolationCount": 42, # Number of current resource violations which are not acknowledged.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeResourceViolationCount": 42, # Number of current resource violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"complianceUpdatesEnabled": True or False, # Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Output only. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
"workloadOptions": { # Options to be set for the given created workload. # Optional. Options to be set for the given created workload.
"kajEnrollmentType": "A String", # Optional. Specifies type of KAJ Enrollment if provided.
},
}

externalId: string, Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, etag=None, x__xgafv=None)

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

Args:
  name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
  etag: string, Optional. The etag of the workload. If this is provided, it must match the server's etag.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

enableComplianceUpdates(name, x__xgafv=None)

This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.

Args:
  name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for EnableComplianceUpdates endpoint.
}

enableResourceMonitoring(name, x__xgafv=None)

Enable resource violation monitoring for a workload.

Args:
  name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for EnableResourceMonitoring endpoint.
}

get(name, x__xgafv=None)

Gets Assured Workload associated with a CRM Node

Args:
name: string, Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Workload object for managing highly regulated workloads of cloud customers.
"availableUpdates": 42, # Output only. The number of updates available for the workload.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedResourceViolationCount": 42, # Number of current resource violations which are not acknowledged.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeResourceViolationCount": 42, # Number of current resource violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"complianceUpdatesEnabled": True or False, # Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Output only. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
"workloadOptions": { # Options to be set for the given created workload. # Optional. Options to be set for the given created workload.
"kajEnrollmentType": "A String", # Optional. Specifies type of KAJ Enrollment if provided.
},
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Assured Workloads under a CRM Node.

Args:
parent: string, Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. (required)
filter: string, A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
pageSize: integer, Page size.
pageToken: string, Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response of ListWorkloads endpoint.
"nextPageToken": "A String", # The next page token. Return empty if reached the last page.
"workloads": [ # List of Workloads under a given parent.
{ # A Workload object for managing highly regulated workloads of cloud customers.
"availableUpdates": 42, # Output only. The number of updates available for the workload.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedResourceViolationCount": 42, # Number of current resource violations which are not acknowledged.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeResourceViolationCount": 42, # Number of current resource violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"complianceUpdatesEnabled": True or False, # Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Output only. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
"workloadOptions": { # Options to be set for the given created workload. # Optional. Options to be set for the given created workload.
"kajEnrollmentType": "A String", # Optional. Specifies type of KAJ Enrollment if provided.
},
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

Args:
name: string, Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. (required)
body: object, The request body.
The object takes the form of:

{ # A Workload object for managing highly regulated workloads of cloud customers.
"availableUpdates": 42, # Output only. The number of updates available for the workload.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedResourceViolationCount": 42, # Number of current resource violations which are not acknowledged.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeResourceViolationCount": 42, # Number of current resource violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"complianceUpdatesEnabled": True or False, # Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Output only. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
"workloadOptions": { # Options to be set for the given created workload. # Optional. Options to be set for the given created workload.
"kajEnrollmentType": "A String", # Optional. Specifies type of KAJ Enrollment if provided.
},
}

updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Workload object for managing highly regulated workloads of cloud customers.
"availableUpdates": 42, # Output only. The number of updates available for the workload.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedResourceViolationCount": 42, # Number of current resource violations which are not acknowledged.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeResourceViolationCount": 42, # Number of current resource violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"complianceUpdatesEnabled": True or False, # Output only. Indicates whether the compliance updates feature is enabled for a workload. The compliance updates feature can be enabled via the EnableComplianceUpdates endpoint.
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Output only. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
},
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
"workloadOptions": { # Options to be set for the given created workload. # Optional. Options to be set for the given created workload.
"kajEnrollmentType": "A String", # Optional. Specifies type of KAJ Enrollment if provided.
},
}

restrictAllowedResources(name, body=None, x__xgafv=None)

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

Args:
  name: string, Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for restricting list of available resources in Workload environment.
  "restrictionType": "A String", # Required. The type of restriction for using gcp products in the Workload environment.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for restricting the list of allowed resources.
}

Assured Workloads API . organizations . locations . workloads

Instance Methods

Method Details