{
  "opencollection": "1.0.0",
  "info": {
    "name": "AWS IoT Accept Certificate Transfer Jobs API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon IoT Core Associate Targets with Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId/targets",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The unique identifier you assigned to this job when it was created."
              },
              {
                "name": "namespaceId",
                "value": "",
                "type": "query",
                "description": "<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is in public preview.</p> </note>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<p>Associates a group with a continuous job. The following criteria must be met: </p> <ul> <li> <p>The job must have been created with the <code>targetSelection</code> field set to \"CONTINUOUS\".</p> </li> <li> <p>The job status must currently be \"IN_PROGRESS\".</p> </li> <li> <p>The total number of targets associated with a job must not exceed 100.</p> </li> </ul> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsi"
        },
        {
          "info": {
            "name": "Amazon IoT Core Cancel Job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId/cancel",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The unique identifier you assigned to this job when it was created."
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "<p>(Optional) If <code>true</code> job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default is <code>false</code>.</p> <p>Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<p>Cancels a job.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">CancelJob</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core Describe Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The unique identifier you assigned to this job when it was created."
              }
            ]
          },
          "docs": "<p>Describes a job.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">DescribeJob</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core Create Job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, \"-\" and \"_\" are valid for use here."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<p>Creates a job.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">CreateJob</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core Update Job",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The ID of the job to be updated."
              },
              {
                "name": "namespaceId",
                "value": "",
                "type": "query",
                "description": "<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is in public preview.</p> </note>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<p>Updates supported fields of the specified job.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">UpdateJob</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core Delete Job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "<p>The ID of the job to be deleted.</p> <p>After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.</p>"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "<p>(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default is false.</p> <note> <p>Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.</p> </note>"
              },
              {
                "name": "namespaceId",
                "value": "",
                "type": "query",
                "description": "<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is in public preview.</p> </note>"
              }
            ]
          },
          "docs": "<p>Deletes a job and its related job executions.</p> <p>Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose status is already \"DELETION_IN_PROGRESS\" will result in an error.</p> <p>Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or a LimitExceededException will occur.</p> "
        },
        {
          "info": {
            "name": "Amazon IoT Core Get Job Document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId/job-document",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The unique identifier you assigned to this job when it was created."
              }
            ]
          },
          "docs": "<p>Gets a job document.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">GetJobDocument</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core List Job Executions for Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://iot.{region}.amazonaws.com/jobs/:jobId/things",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The unique identifier you assigned to this job when it was created."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the job."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to be returned per request."
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "The token to retrieve the next set of results."
              }
            ]
          },
          "docs": "<p>Lists the job executions for a job.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListJobExecutionsForJob</a> action.</p>"
        },
        {
          "info": {
            "name": "Amazon IoT Core List Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://iot.{region}.amazonaws.com/jobs",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "An optional filter that lets you search for jobs that have the specified status."
              },
              {
                "name": "targetSelection",
                "value": "",
                "type": "query",
                "description": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. </p> <note> <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.</p> </note>"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return per request."
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "The token to retrieve the next set of results."
              },
              {
                "name": "thingGroupName",
                "value": "",
                "type": "query",
                "description": "A filter that limits the returned jobs to those for the specified group."
              },
              {
                "name": "thingGroupId",
                "value": "",
                "type": "query",
                "description": "A filter that limits the returned jobs to those for the specified group."
              },
              {
                "name": "namespaceId",
                "value": "",
                "type": "query",
                "description": "<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is in public preview.</p> </note>"
              }
            ]
          },
          "docs": "<p>Lists jobs.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListJobs</a> action.</p>"
        }
      ]
    }
  ],
  "bundled": true
}