iam_work_requests
Creates, updates, deletes, gets or lists an iam_work_requests resource.
Overview​
| Name | iam_work_requests |
| Type | Resource |
| Id | oci.identity.iam_work_requests |
Fields​
The following fields are returned by SELECT queries:
- get
- list
IAM Work request
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the work request. |
compartmentId | string | The OCID of the compartment containing this IAM work request. |
operationType | string | The asynchronous operation tracked by this IAM work request. (CREATE_DOMAIN, REPLICATE_DOMAIN_TO_REGION, UPDATE_DOMAIN, ACTIVATE_DOMAIN, DEACTIVATE_DOMAIN, DELETE_DOMAIN, CHANGE_COMPARTMENT_FOR_DOMAIN, CHANGE_LICENSE_TYPE_FOR_DOMAIN) |
percentComplete | number (float) | How much progress the operation has made. |
resources | array | The resources this work request affects. |
status | string | The status of the work request. (ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED) |
timeAccepted | string (date-time) | Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
timeFinished | string (date-time) | Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
timeStarted | string (date-time) | Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
(For tenancies that support identity domains) The IAM work request summary. Tracks the status of asynchronous operations.<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the work request. |
compartmentId | string | The OCID of the compartment containing this IAM work request. |
operationType | string | The asynchronous operation tracked by this IAM work request. (CREATE_DOMAIN, REPLICATE_DOMAIN_TO_REGION, UPDATE_DOMAIN, ACTIVATE_DOMAIN, DEACTIVATE_DOMAIN, DELETE_DOMAIN, CHANGE_COMPARTMENT_FOR_DOMAIN, CHANGE_LICENSE_TYPE_FOR_DOMAIN) |
percentComplete | number (float) | How much progress the operation has made. |
resources | array | The resources this work request affects. |
status | string | The status of the work request. (ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED) |
timeAccepted | string (date-time) | Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
timeFinished | string (date-time) | Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
timeStarted | string (date-time) | Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | iamWorkRequestId, region | opc-request-id | Gets the details of a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.<br /> |
list | select | compartmentId, region | page, limit, resourceIdentifier, opc-request-id | Lists the IAM work requests in compartment. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
compartmentId | string | The OCID of the compartment (remember that the tenancy is simply the root compartment). |
iamWorkRequestId | string | The OCID of the IAM work request. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
limit | integer | The maximum number of items to return in a paginated "List" call. |
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
page | string | The value of the opc-next-page response header from the previous "List" call. |
resourceIdentifier | string | The identifier of the resource the work request affects. |
SELECT examples​
- get
- list
Gets the details of a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.<br />
SELECT
id,
compartmentId,
operationType,
percentComplete,
resources,
status,
timeAccepted,
timeFinished,
timeStarted
FROM oci.identity.iam_work_requests
WHERE iamWorkRequestId = '{{ iamWorkRequestId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Lists the IAM work requests in compartment. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.<br />
SELECT
id,
compartmentId,
operationType,
percentComplete,
resources,
status,
timeAccepted,
timeFinished,
timeStarted
FROM oci.identity.iam_work_requests
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND resourceIdentifier = '{{ resourceIdentifier }}'
AND opc-request-id = '{{ opc-request-id }}'
;