|
21 | 21 | "CreateAuditSuppression": "<p> Creates a Device Defender audit suppression. </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\">CreateAuditSuppression</a> action.</p>", |
22 | 22 | "CreateAuthorizer": "<p>Creates an authorizer.</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\">CreateAuthorizer</a> action.</p>", |
23 | 23 | "CreateBillingGroup": "<p>Creates a billing group.</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\">CreateBillingGroup</a> action.</p>", |
24 | | - "CreateCertificateFromCsr": "<p>Creates an X.509 certificate using the specified certificate signing request.</p> <p> <b>Note:</b> The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-512 curves. For supported certificates, consult <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms\"> Certificate signing algorithms supported by IoT</a>.</p> <p> <b>Note:</b> Reusing the same certificate signing request (CSR) results in a distinct certificate.</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\">CreateCertificateFromCsr</a> action.</p> <p>You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.</p> <p>Assuming a set of CSRs are located inside of the directory my-csr-directory:</p> <p>On Linux and OS X, the command is:</p> <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.</p> <p>The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:</p> <p>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}</p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"</p>", |
| 24 | + "CreateCertificateFromCsr": "<p>Creates an X.509 certificate using the specified certificate signing request. </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\">CreateCertificateFromCsr</a> action. </p> <note> <p>The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-25 or NIST P-384 curves. For supported certificates, consult <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms\"> Certificate signing algorithms supported by IoT</a>. </p> </note> <note> <p>Reusing the same certificate signing request (CSR) results in a distinct certificate.</p> </note> <p>You can create multiple certificates in a batch by creating a directory, copying multiple <code>.csr</code> files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:</p> <p>On Linux and OS X, the command is: </p> <p> <code>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</code> </p> <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the <code>aws iot create-certificate-from-csr</code> Amazon Web Services CLI command to create a certificate for the corresponding CSR. </p> <p>You can also run the <code>aws iot create-certificate-from-csr</code> part of the command in parallel to speed up the certificate creation process:</p> <p> <code>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} </code> </p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p> <code>> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} </code> </p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p> <code>> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\" </code> </p>", |
25 | 25 | "CreateCustomMetric": "<p> Use this API to define a Custom Metric published by your devices to Device Defender. </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\">CreateCustomMetric</a> action.</p>", |
26 | 26 | "CreateDimension": "<p>Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</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\">CreateDimension</a> action.</p>", |
27 | 27 | "CreateDomainConfiguration": "<p>Creates a domain configuration.</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\">CreateDomainConfiguration</a> action.</p>", |
|
2110 | 2110 | "UpdateRoleAliasRequest$credentialDurationSeconds": "<p>The number of seconds the credential will be valid.</p> <p>This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.</p>" |
2111 | 2111 | } |
2112 | 2112 | }, |
| 2113 | + "CronExpression": { |
| 2114 | + "base": null, |
| 2115 | + "refs": { |
| 2116 | + "MaintenanceWindow$startTime": "<p>Displays the start time of the next maintenance window.</p>" |
| 2117 | + } |
| 2118 | + }, |
2113 | 2119 | "CustomCodeSigning": { |
2114 | 2120 | "base": "<p>Describes a custom method used to code sign a file.</p>", |
2115 | 2121 | "refs": { |
|
3171 | 3177 | "DescribeDomainConfigurationResponse$domainType": "<p>The type of the domain.</p>" |
3172 | 3178 | } |
3173 | 3179 | }, |
| 3180 | + "DurationInMinutes": { |
| 3181 | + "base": null, |
| 3182 | + "refs": { |
| 3183 | + "MaintenanceWindow$durationInMinutes": "<p>Displays the duration of the next maintenance window.</p>" |
| 3184 | + } |
| 3185 | + }, |
3174 | 3186 | "DurationSeconds": { |
3175 | 3187 | "base": null, |
3176 | 3188 | "refs": { |
|
3560 | 3572 | "FleetMetricUnit": { |
3561 | 3573 | "base": null, |
3562 | 3574 | "refs": { |
3563 | | - "CreateFleetMetricRequest$unit": "<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">CW metric</a>. Default to null.</p>", |
3564 | | - "DescribeFleetMetricResponse$unit": "<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">CW metric</a>.</p>", |
| 3575 | + "CreateFleetMetricRequest$unit": "<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">CW metric</a>. Default to null.</p>", |
| 3576 | + "DescribeFleetMetricResponse$unit": "<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">CW metric</a>.</p>", |
3565 | 3577 | "UpdateFleetMetricRequest$unit": "<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">CW metric</a>.</p>" |
3566 | 3578 | } |
3567 | 3579 | }, |
|
5059 | 5071 | "BehaviorCriteria$mlDetectionConfig": "<p> The configuration of an ML Detect </p>" |
5060 | 5072 | } |
5061 | 5073 | }, |
| 5074 | + "MaintenanceWindow": { |
| 5075 | + "base": "<p>An optional configuration within the <code>SchedulingConfig</code> to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.</p>", |
| 5076 | + "refs": { |
| 5077 | + "MaintenanceWindows$member": null |
| 5078 | + } |
| 5079 | + }, |
| 5080 | + "MaintenanceWindows": { |
| 5081 | + "base": null, |
| 5082 | + "refs": { |
| 5083 | + "CreateJobTemplateRequest$maintenanceWindows": "<p>Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.</p>", |
| 5084 | + "DescribeJobTemplateResponse$maintenanceWindows": "<p>Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.</p>", |
| 5085 | + "SchedulingConfig$maintenanceWindows": "<p>An optional configuration within the <code>SchedulingConfig</code> to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.</p>" |
| 5086 | + } |
| 5087 | + }, |
5062 | 5088 | "MalformedPolicyException": { |
5063 | 5089 | "base": "<p>The policy documentation is not valid.</p>", |
5064 | 5090 | "refs": { |
|
6765 | 6791 | "UpdateScheduledAuditRequest$scheduledAuditName": "<p>The name of the scheduled audit. (Max. 128 chars)</p>" |
6766 | 6792 | } |
6767 | 6793 | }, |
| 6794 | + "ScheduledJobRollout": { |
| 6795 | + "base": "<p>Displays the next seven maintenance window occurrences and their start times.</p>", |
| 6796 | + "refs": { |
| 6797 | + "ScheduledJobRolloutList$member": null |
| 6798 | + } |
| 6799 | + }, |
| 6800 | + "ScheduledJobRolloutList": { |
| 6801 | + "base": null, |
| 6802 | + "refs": { |
| 6803 | + "Job$scheduledJobRollouts": "<p>Displays the next seven maintenance window occurrences and their start times.</p>" |
| 6804 | + } |
| 6805 | + }, |
6768 | 6806 | "SchedulingConfig": { |
6769 | 6807 | "base": "<p>Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.</p>", |
6770 | 6808 | "refs": { |
|
7309 | 7347 | "StringDateTime": { |
7310 | 7348 | "base": null, |
7311 | 7349 | "refs": { |
7312 | | - "SchedulingConfig$startTime": "<p>The time a job will begin rollout of the job document to all devices in the target group for a job. The <code>startTime</code> can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time.</p>", |
7313 | | - "SchedulingConfig$endTime": "<p>The time a job will stop rollout of the job document to all devices in the target group for a job. The <code>endTime</code> must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between <code>startTime</code> and <code>endTime</code> is thirty minutes. The maximum duration between <code>startTime</code> and <code>endTime</code> is two years. </p>" |
| 7350 | + "ScheduledJobRollout$startTime": "<p>Displays the start times of the next seven maintenance window occurrences.</p>", |
| 7351 | + "SchedulingConfig$startTime": "<p>The time a job will begin rollout of the job document to all devices in the target group for a job. The <code>startTime</code> can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the <code>startTime</code> is YYYY-MM-DD for the date and HH:MM for the time.</p>", |
| 7352 | + "SchedulingConfig$endTime": "<p>The time a job will stop rollout of the job document to all devices in the target group for a job. The <code>endTime</code> must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between <code>startTime</code> and <code>endTime</code> is thirty minutes. The maximum duration between <code>startTime</code> and <code>endTime</code> is two years. The date and time format for the <code>endTime</code> is YYYY-MM-DD for the date and HH:MM for the time.</p>" |
7314 | 7353 | } |
7315 | 7354 | }, |
7316 | 7355 | "StringList": { |
|
0 commit comments