|
384 | 384 | "shape": "InternalServerException" |
385 | 385 | } |
386 | 386 | ], |
387 | | - "documentation": "<p>Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.</p>" |
| 387 | + "documentation": "<p>Gets the recipe for a version of a component.</p>" |
388 | 388 | }, |
389 | 389 | "GetComponentVersionArtifact": { |
390 | 390 | "name": "GetComponentVersionArtifact", |
|
469 | 469 | "shape": "ThrottlingException" |
470 | 470 | } |
471 | 471 | ], |
472 | | - "documentation": "<p>Retrieves metadata for a Greengrass core device.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> </ul> </note>" |
| 472 | + "documentation": "<p>Retrieves metadata for a Greengrass core device.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> <li> <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment</p> </li> </ul> </note>" |
473 | 473 | }, |
474 | 474 | "GetDeployment": { |
475 | 475 | "name": "GetDeployment", |
|
642 | 642 | "shape": "ThrottlingException" |
643 | 643 | } |
644 | 644 | ], |
645 | | - "documentation": "<p>Retrieves a paginated list of Greengrass core devices.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> </ul> </note>" |
| 645 | + "documentation": "<p>Retrieves a paginated list of Greengrass core devices.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> <li> <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment</p> </li> </ul> </note>" |
646 | 646 | }, |
647 | 647 | "ListDeployments": { |
648 | 648 | "name": "ListDeployments", |
|
732 | 732 | "shape": "ThrottlingException" |
733 | 733 | } |
734 | 734 | ], |
735 | | - "documentation": "<p>Retrieves a paginated list of the components that a Greengrass core device runs. This list doesn't include components that are deployed from local deployments or components that are deployed as dependencies of other components.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> </ul> </note>" |
| 735 | + "documentation": "<p>Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the <code>topologyFilter</code> parameter to <code>ALL</code>.</p> <note> <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.</p> <p>Core devices send status updates at the following times:</p> <ul> <li> <p>When the IoT Greengrass Core software starts</p> </li> <li> <p>When the core device receives a deployment from the Amazon Web Services Cloud</p> </li> <li> <p>When the status of any component on the core device becomes <code>BROKEN</code> </p> </li> <li> <p>At a <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss\">regular interval that you can configure</a>, which defaults to 24 hours</p> </li> <li> <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment</p> </li> </ul> </note>" |
736 | 736 | }, |
737 | 737 | "ListTagsForResource": { |
738 | 738 | "name": "ListTagsForResource", |
|
1265 | 1265 | }, |
1266 | 1266 | "attributes": { |
1267 | 1267 | "shape": "PlatformAttributesMap", |
1268 | | - "documentation": "<p>A dictionary of attributes for the platform. The IoT Greengrass Core software defines the <code>os</code> and <code>platform</code> by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html\">Greengrass nucleus component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>" |
| 1268 | + "documentation": "<p>A dictionary of attributes for the platform. The IoT Greengrass Core software defines the <code>os</code> and <code>architecture</code> by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html\">Greengrass nucleus component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>" |
1269 | 1269 | } |
1270 | 1270 | }, |
1271 | 1271 | "documentation": "<p>Contains information about a platform that a component supports.</p>" |
|
1479 | 1479 | "documentation": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the target IoT thing or thing group.</p>" |
1480 | 1480 | }, |
1481 | 1481 | "deploymentName": { |
1482 | | - "shape": "NonEmptyString", |
| 1482 | + "shape": "DeploymentNameString", |
1483 | 1483 | "documentation": "<p>The name of the deployment.</p>" |
1484 | 1484 | }, |
1485 | 1485 | "components": { |
|
1680 | 1680 | "DeploymentName": { |
1681 | 1681 | "type": "string" |
1682 | 1682 | }, |
| 1683 | + "DeploymentNameString": { |
| 1684 | + "type": "string", |
| 1685 | + "max": 256, |
| 1686 | + "min": 1 |
| 1687 | + }, |
1683 | 1688 | "DeploymentPolicies": { |
1684 | 1689 | "type": "structure", |
1685 | 1690 | "members": { |
|
2177 | 2182 | "isRoot": { |
2178 | 2183 | "shape": "IsRoot", |
2179 | 2184 | "documentation": "<p>Whether or not the component is a root component.</p>" |
| 2185 | + }, |
| 2186 | + "lastStatusChangeTimestamp": { |
| 2187 | + "shape": "Timestamp", |
| 2188 | + "documentation": "<p>The status of how current the data is.</p> <p>This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.</p>" |
2180 | 2189 | } |
2181 | 2190 | }, |
2182 | 2191 | "documentation": "<p>Contains information about a component on a Greengrass core device.</p>" |
|
2200 | 2209 | "shape": "InstalledComponent" |
2201 | 2210 | } |
2202 | 2211 | }, |
| 2212 | + "InstalledComponentTopologyFilter": { |
| 2213 | + "type": "string", |
| 2214 | + "enum": [ |
| 2215 | + "ALL", |
| 2216 | + "ROOT" |
| 2217 | + ] |
| 2218 | + }, |
2203 | 2219 | "IoTJobARN": { |
2204 | 2220 | "type": "string", |
2205 | 2221 | "pattern": "arn:[^:]*:iot:[^:]+:[0-9]+:job/.+" |
|
2542 | 2558 | "rw" |
2543 | 2559 | ] |
2544 | 2560 | }, |
2545 | | - "LambdaFunctionARNWithVersionNumber": { |
2546 | | - "type": "string", |
2547 | | - "pattern": "arn:[^:]*:lambda:[^:]+:[0-9]+:function:[a-zA-Z0-9-_]+:[0-9]+" |
2548 | | - }, |
2549 | 2561 | "LambdaFunctionRecipeSource": { |
2550 | 2562 | "type": "structure", |
2551 | 2563 | "required": [ |
2552 | 2564 | "lambdaArn" |
2553 | 2565 | ], |
2554 | 2566 | "members": { |
2555 | 2567 | "lambdaArn": { |
2556 | | - "shape": "LambdaFunctionARNWithVersionNumber", |
| 2568 | + "shape": "NonEmptyString", |
2557 | 2569 | "documentation": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the Lambda function. The ARN must include the version of the function to import. You can't use version aliases like <code>$LATEST</code>.</p>" |
2558 | 2570 | }, |
2559 | 2571 | "componentName": { |
|
2920 | 2932 | "box": true, |
2921 | 2933 | "location": "querystring", |
2922 | 2934 | "locationName": "nextToken" |
| 2935 | + }, |
| 2936 | + "topologyFilter": { |
| 2937 | + "shape": "InstalledComponentTopologyFilter", |
| 2938 | + "documentation": "<p>The filter for the list of components. Choose from the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all components installed on the core device.</p> </li> <li> <p> <code>ROOT</code> – The list includes only <i>root</i> components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.</p> </li> </ul> <p>Default: <code>ROOT</code> </p>", |
| 2939 | + "box": true, |
| 2940 | + "location": "querystring", |
| 2941 | + "locationName": "topologyFilter" |
2923 | 2942 | } |
2924 | 2943 | } |
2925 | 2944 | }, |
|
2928 | 2947 | "members": { |
2929 | 2948 | "installedComponents": { |
2930 | 2949 | "shape": "InstalledComponentList", |
2931 | | - "documentation": "<p>A list that summarizes each component on the core device.</p>" |
| 2950 | + "documentation": "<p>A list that summarizes each component on the core device.</p> <note> <p>Accuracy of the <code>lastStatusChangeTimestamp</code> response depends on Greengrass nucleus v2.7.0. It performs best on Greengrass nucleus v2.7.0 and can be inaccurate on earlier versions.</p> </note>" |
2932 | 2951 | }, |
2933 | 2952 | "nextToken": { |
2934 | 2953 | "shape": "NextTokenString", |
|
0 commit comments