AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with AWS IoT Core and export IoT data to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.
AWS IoT Greengrass Version 2 provides a new major version of the AWS IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the AWS IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.
For more information, see What is AWS IoT Greengrass? in the AWS IoT Greengrass V2 Developer Guide.
", + "service": "IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.
IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.
For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.
", "operations": { - "BatchAssociateClientDeviceWithCoreDevice": "Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the AWS IoT Greengrass V2 Developer Guide.
Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see Interact with local IoT devices in the AWS IoT Greengrass V2 Developer Guide.
Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.
Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
", "CancelDeployment": "Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.
", - "CreateComponentVersion": "Creates a component. Components are software that run on AWS IoT Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS IoT Greengrass. Then, you can deploy the component to other core devices.
You can use this operation to do the following:
Create components from recipes
Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see AWS IoT Greengrass component recipe reference in the AWS IoT Greengrass V2 Developer Guide.
To create a component from a recipe, specify inlineRecipe when you call this operation.
Create components from Lambda functions
Create a component from an AWS Lambda function that runs on AWS IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2.
This function only accepts Lambda functions that use the following runtimes:
Python 2.7 – python2.7
Python 3.7 – python3.7
Python 3.8 – python3.8
Java 8 – java8
Node.js 10 – nodejs10.x
Node.js 12 – nodejs12.x
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
", - "DeleteComponent": "Deletes a version of a component from AWS IoT Greengrass.
This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more information about how to delete the AWS IoT thing, see DeleteThing in the AWS IoT API Reference.
", + "CreateComponentVersion": "Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.
You can use this operation to do the following:
Create components from recipes
Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide.
To create a component from a recipe, specify inlineRecipe when you call this operation.
Create components from Lambda functions
Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.
This function only accepts Lambda functions that use the following runtimes:
Python 2.7 – python2.7
Python 3.7 – python3.7
Python 3.8 – python3.8
Java 8 – java8
Node.js 10 – nodejs10.x
Node.js 12 – nodejs12.x
To create a component from a Lambda function, specify lambdaFunction when you call this operation.
Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
", + "DeleteComponent": "Deletes a version of a component from IoT Greengrass.
This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.
", "DescribeComponent": "Retrieves metadata for a version of a component.
", "GetComponent": "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.
", "GetComponentVersionArtifact": "Gets the pre-signed URL to download a public component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
", - "GetCoreDevice": "Retrieves metadata for a AWS IoT Greengrass core device.
", - "GetDeployment": "Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.
", + "GetCoreDevice": "Retrieves metadata for a Greengrass core device.
", + "GetDeployment": "Gets a deployment. Deployments define the components that run on Greengrass core devices.
", "ListClientDevicesAssociatedWithCoreDevice": "Retrieves a paginated list of client devices that are associated with a core device.
", "ListComponentVersions": "Retrieves a paginated list of all versions for a component. Greater versions are listed first.
", "ListComponents": "Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
", - "ListCoreDevices": "Retrieves a paginated list of AWS IoT Greengrass core devices.
", + "ListCoreDevices": "Retrieves a paginated list of Greengrass core devices.
", "ListDeployments": "Retrieves a paginated list of deployments.
", - "ListEffectiveDeployments": "Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
", - "ListInstalledComponents": "Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
", - "ListTagsForResource": "Retrieves the list of tags for an AWS IoT Greengrass resource.
", - "ResolveComponentCandidates": "Retrieves a list of components that meet the component, version, and platform requirements of a deployment. AWS IoT Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.
Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
", - "UntagResource": "Removes a tag from an AWS IoT Greengrass resource.
" + "ListEffectiveDeployments": "Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
", + "ListInstalledComponents": "Retrieves a paginated list of the components that a Greengrass core device runs.
", + "ListTagsForResource": "Retrieves the list of tags for an IoT Greengrass resource.
", + "ResolveComponentCandidates": "Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.
Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
", + "UntagResource": "Removes a tag from an IoT Greengrass resource.
" }, "shapes": { "AccessDeniedException": { @@ -53,7 +53,7 @@ "AssociateClientDeviceWithCoreDeviceErrorList": { "base": null, "refs": { - "BatchAssociateClientDeviceWithCoreDeviceResponse$errorEntries": "The list of any errors for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to associate.
" + "BatchAssociateClientDeviceWithCoreDeviceResponse$errorEntries": "The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to associate.
" } }, "AssociatedClientDevice": { @@ -88,6 +88,12 @@ "refs": { } }, + "CPU": { + "base": null, + "refs": { + "SystemResourceLimits$cpus": "The maximum amount of CPU time that a component's processes can use on the core device. A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core software doesn't limit the component's CPU usage.
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
", + "CreateDeploymentRequest$clientToken": "A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
" + } + }, "CloudComponentState": { "base": null, "refs": { @@ -105,10 +118,10 @@ } }, "CloudComponentStatus": { - "base": "Contains the status of a component in the AWS IoT Greengrass service.
", + "base": "Contains the status of a component in the IoT Greengrass service.
", "refs": { - "CreateComponentVersionResponse$status": "The status of the component version in AWS IoT Greengrass V2. This status is different from the status of the component on a core device.
", - "DescribeComponentResponse$status": "The status of the component version in AWS IoT Greengrass V2. This status is different from the status of the component on a core device.
" + "CreateComponentVersionResponse$status": "The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
", + "DescribeComponentResponse$status": "The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
" } }, "Component": { @@ -125,7 +138,7 @@ } }, "ComponentCandidate": { - "base": "Contains information about a component that is a candidate to deploy to a AWS IoT Greengrass core device.
", + "base": "Contains information about a component that is a candidate to deploy to a Greengrass core device.
", "refs": { "ComponentCandidateList$member": null } @@ -145,19 +158,19 @@ "ComponentConfigurationPathList": { "base": null, "refs": { - "ComponentConfigurationUpdate$reset": "The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the AWS IoT Greengrass V2 Developer Guide.
The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the IoT Greengrass V2 Developer Guide.
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the AWS IoT Greengrass V2 Developer Guide.
" + "ComponentConfigurationUpdate$merge": "A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the IoT Greengrass V2 Developer Guide.
" } }, "ComponentConfigurationUpdate": { - "base": "Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide.
", + "base": "Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.
", "refs": { - "ComponentDeploymentSpecification$configurationUpdate": "The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide.
" + "ComponentDeploymentSpecification$configurationUpdate": "The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.
" } }, "ComponentDependencyMap": { @@ -232,9 +245,9 @@ } }, "ComponentRunWith": { - "base": "Contains information system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide.
", + "base": "Contains information system user and group that the IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.
", "refs": { - "ComponentDeploymentSpecification$runWith": "The system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the AWS IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide.
" + "ComponentDeploymentSpecification$runWith": "The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.
" } }, "ComponentVersionARN": { @@ -265,7 +278,7 @@ "ComponentVersionRequirementMap": { "base": null, "refs": { - "ComponentCandidate$versionRequirements": "The version requirements for the component's dependencies. AWS IoT Greengrass core devices get the version requirements from component recipes.
AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
" + "ComponentCandidate$versionRequirements": "The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
" } }, "ComponentVersionString": { @@ -294,7 +307,7 @@ } }, "CoreDevice": { - "base": "Contains information about a AWS IoT Greengrass core device, which is an AWS IoT thing that runs the AWS IoT Greengrass Core software.
", + "base": "Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.
", "refs": { "CoreDevicesList$member": null } @@ -314,20 +327,20 @@ "CoreDeviceStatus": { "base": null, "refs": { - "CoreDevice$status": "The status of the core device. Core devices can have the following statuses:
HEALTHY – The AWS IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The AWS IoT Greengrass Core software or a component is in a failed state on the core device.
The status of the core device. The core device status can be:
HEALTHY – The AWS IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The AWS IoT Greengrass Core software or a component is in a failed state on the core device.
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
HEALTHY – The AWS IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The AWS IoT Greengrass Core software or a component is in a failed state on the core device.
The status of the core device. Core devices can have the following statuses:
HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
The status of the core device. The core device status can be:
HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
The name of the core device. This is also the name of the AWS IoT thing.
", - "DeleteCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "GetCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "GetCoreDeviceResponse$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "ListEffectiveDeploymentsRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "ListInstalledComponentsRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
" + "CoreDevice$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "DeleteCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "GetCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "GetCoreDeviceResponse$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "ListEffectiveDeploymentsRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "ListInstalledComponentsRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
" } }, "CoreDevicesList": { @@ -393,11 +406,11 @@ "DeploymentComponentUpdatePolicyAction": { "base": null, "refs": { - "DeploymentComponentUpdatePolicy$action": "Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the AWS IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see Create deployments in the AWS IoT Greengrass V2 Developer Guide.
", + "base": "Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.
", "refs": { "DeploymentPolicies$configurationValidationPolicy": "The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
" } @@ -421,7 +434,7 @@ } }, "DeploymentIoTJobConfiguration": { - "base": "Contains information about an AWS IoT job configuration.
", + "base": "Contains information about an IoT job configuration.
", "refs": { "CreateDeploymentRequest$iotJobConfiguration": "The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
", "GetDeploymentResponse$iotJobConfiguration": "The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
" @@ -436,7 +449,7 @@ "DeploymentName": { "base": null, "refs": { - "EffectiveDeployment$deploymentName": "The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
The name of the deployment.
" } }, "DeploymentPolicies": { @@ -496,11 +509,11 @@ "DisassociateClientDeviceFromCoreDeviceErrorList": { "base": null, "refs": { - "BatchDisassociateClientDeviceFromCoreDeviceResponse$errorEntries": "The list of errors (if any) for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to disassociate.
" + "BatchDisassociateClientDeviceFromCoreDeviceResponse$errorEntries": "The list of errors (if any) for the entries in the request. Each error entry contains the name of the IoT thing that failed to disassociate.
" } }, "EffectiveDeployment": { - "base": "Contains information about a deployment job that AWS IoT Greengrass sends to a AWS IoT Greengrass core device.
", + "base": "Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
", "refs": { "EffectiveDeploymentsList$member": null } @@ -508,7 +521,7 @@ "EffectiveDeploymentExecutionStatus": { "base": null, "refs": { - "EffectiveDeployment$coreDeviceExecutionStatus": "The status of the deployment job on the AWS IoT Greengrass core device.
" + "EffectiveDeployment$coreDeviceExecutionStatus": "The status of the deployment job on the Greengrass core device.
" } }, "EffectiveDeploymentsList": { @@ -528,7 +541,7 @@ "GGCVersion": { "base": null, "refs": { - "GetCoreDeviceResponse$coreVersion": "The version of the AWS IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the AWS IoT Greengrass nucleus component that runs on the core device. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
" + "GetCoreDeviceResponse$coreVersion": "The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
" } }, "GenericV2ARN": { @@ -580,7 +593,7 @@ } }, "InstalledComponent": { - "base": "Contains information about a component on a AWS IoT Greengrass core device.
", + "base": "Contains information about a component on a Greengrass core device.
", "refs": { "InstalledComponentList$member": null } @@ -598,16 +611,16 @@ } }, "InternalServerException": { - "base": "AWS IoT Greengrass can't process your request right now. Try again later.
", + "base": "IoT Greengrass can't process your request right now. Try again later.
", "refs": { } }, "IoTJobARN": { "base": null, "refs": { - "CreateDeploymentResponse$iotJobArn": "The ARN of the AWS IoT job that applies the deployment to target devices.
", - "EffectiveDeployment$iotJobArn": "The ARN of the AWS IoT job that applies the deployment to target devices.
", - "GetDeploymentResponse$iotJobArn": "The ARN of the AWS IoT job that applies the deployment to target devices.
" + "CreateDeploymentResponse$iotJobArn": "The ARN of the IoT job that applies the deployment to target devices.
", + "EffectiveDeployment$iotJobArn": "The ARN of the IoT job that applies the deployment to target devices.
", + "GetDeploymentResponse$iotJobArn": "The ARN of the IoT job that applies the deployment to target devices.
" } }, "IoTJobAbortAction": { @@ -661,7 +674,7 @@ "IoTJobId": { "base": null, "refs": { - "EffectiveDeployment$iotJobId": "The ID of the AWS IoT job that applies the deployment to target devices.
" + "EffectiveDeployment$iotJobId": "The ID of the IoT job that applies the deployment to target devices.
" } }, "IoTJobInProgressTimeoutInMinutes": { @@ -716,14 +729,14 @@ "IoTThingName": { "base": null, "refs": { - "AssociateClientDeviceWithCoreDeviceEntry$thingName": "The name of the AWS IoT thing that represents the client device to associate.
", - "AssociateClientDeviceWithCoreDeviceErrorEntry$thingName": "The name of the AWS IoT thing whose associate request failed.
", - "AssociatedClientDevice$thingName": "The name of the AWS IoT thing that represents the associated client device.
", - "BatchAssociateClientDeviceWithCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "BatchDisassociateClientDeviceFromCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
", - "DisassociateClientDeviceFromCoreDeviceEntry$thingName": "The name of the AWS IoT thing that represents the client device to disassociate.
", - "DisassociateClientDeviceFromCoreDeviceErrorEntry$thingName": "The name of the AWS IoT thing whose disassociate request failed.
", - "ListClientDevicesAssociatedWithCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the AWS IoT thing.
" + "AssociateClientDeviceWithCoreDeviceEntry$thingName": "The name of the IoT thing that represents the client device to associate.
", + "AssociateClientDeviceWithCoreDeviceErrorEntry$thingName": "The name of the IoT thing whose associate request failed.
", + "AssociatedClientDevice$thingName": "The name of the IoT thing that represents the associated client device.
", + "BatchAssociateClientDeviceWithCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "BatchDisassociateClientDeviceFromCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
", + "DisassociateClientDeviceFromCoreDeviceEntry$thingName": "The name of the IoT thing that represents the client device to disassociate.
", + "DisassociateClientDeviceFromCoreDeviceErrorEntry$thingName": "The name of the IoT thing whose disassociate request failed.
", + "ListClientDevicesAssociatedWithCoreDeviceRequest$coreDeviceThingName": "The name of the core device. This is also the name of the IoT thing.
" } }, "IsLatestForTarget": { @@ -740,7 +753,7 @@ } }, "LambdaContainerParams": { - "base": "Contains information about a container in which AWS Lambda functions run on AWS IoT Greengrass core devices.
", + "base": "Contains information about a container in which Lambda functions run on Greengrass core devices.
", "refs": { "LambdaLinuxProcessParams$containerParams": "The parameters for the container in which the Lambda function runs.
" } @@ -764,7 +777,7 @@ } }, "LambdaEventSource": { - "base": "Contains information about an event source for an AWS Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.
", + "base": "Contains information about an event source for an Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.
", "refs": { "LambdaEventSourceList$member": null } @@ -772,13 +785,13 @@ "LambdaEventSourceList": { "base": null, "refs": { - "LambdaExecutionParameters$eventSources": "The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages.
" + "LambdaExecutionParameters$eventSources": "The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.
" } }, "LambdaEventSourceType": { "base": null, "refs": { - "LambdaEventSource$type": "The type of event source. Choose from the following options:
PUB_SUB – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (+ and #) in the event source topic.
IOT_CORE – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards (+ and #) in the event source topic.
The type of event source. Choose from the following options:
PUB_SUB – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (+ and #) in the event source topic.
IOT_CORE – Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type supports MQTT wildcards (+ and #) in the event source topic.
Contains parameters for a Lambda function that runs on AWS IoT Greengrass.
", + "base": "Contains parameters for a Lambda function that runs on IoT Greengrass.
", "refs": { - "LambdaFunctionRecipeSource$componentLambdaParameters": "The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device.
" + "LambdaFunctionRecipeSource$componentLambdaParameters": "The system and runtime parameters for the Lambda function as it runs on the Greengrass core device.
" } }, "LambdaFilesystemPermission": { @@ -813,7 +826,7 @@ } }, "LambdaFunctionRecipeSource": { - "base": "Contains information about an AWS Lambda function to import to create a component.
", + "base": "Contains information about an Lambda function to import to create a component.
", "refs": { "CreateComponentVersionRequest$lambdaFunction": "The parameters to create a component from a Lambda function.
You must specify either inlineRecipe or lambdaFunction.
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
Contains parameters for a Linux process that contains an AWS Lambda function.
", + "base": "Contains parameters for a Linux process that contains an Lambda function.
", "refs": { "LambdaExecutionParameters$linuxProcessParams": "The parameters for the Linux process that contains the Lambda function.
" } @@ -843,7 +856,7 @@ } }, "LambdaVolumeMount": { - "base": "Contains information about a volume that Linux processes in a container can access. When you define a volume, the AWS IoT Greengrass Core software mounts the source files to the destination inside the container.
", + "base": "Contains information about a volume that Linux processes in a container can access. When you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the container.
", "refs": { "LambdaVolumeList$member": null } @@ -934,6 +947,12 @@ "refs": { } }, + "Memory": { + "base": null, + "refs": { + "SystemResourceLimits$memory": "The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.
" + } + }, "NextTokenString": { "base": null, "refs": { @@ -962,21 +981,21 @@ "CancelDeploymentResponse$message": "A message that communicates if the cancel was successful.
", "CloudComponentStatus$message": "A message that communicates details, such as errors, about the status of the component.
", "ComponentDependencyMap$key": null, - "ComponentDependencyRequirement$versionRequirement": "The component version requirement for the component dependency.
AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
", + "ComponentDependencyRequirement$versionRequirement": "The component version requirement for the component dependency.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
", "ComponentDeploymentSpecifications$key": null, "ComponentLatestVersion$description": "The description of the component version.
", "ComponentLatestVersion$publisher": "The publisher of the component version.
", - "ComponentPlatform$name": "The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and architecture of the platform.
The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon (:) in the following format: user:group. The group is optional. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group.
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, IoT Greengrass creates a friendly name from the os and architecture of the platform.
The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon (:) in the following format: user:group. The group is optional. If you don't specify a group, the IoT Greengrass Core software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
", "ComponentVersionListItem$arn": "The ARN of the component version.
", "ComponentVersionRequirementMap$key": null, "ComponentVersionRequirementMap$value": null, - "CreateDeploymentRequest$deploymentName": "The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
The name of the deployment.
", "CreateDeploymentResponse$deploymentId": "The ID of the deployment.
", - "CreateDeploymentResponse$iotJobId": "The ID of the AWS IoT job that applies the deployment to target devices.
", + "CreateDeploymentResponse$iotJobId": "The ID of the IoT job that applies the deployment to target devices.
", "Deployment$revisionId": "The revision number of the deployment.
", "Deployment$deploymentId": "The ID of the deployment.
", - "Deployment$deploymentName": "The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
The name of the deployment.
", "DisassociateClientDeviceFromCoreDeviceErrorEntry$code": "The error code for the request.
", "DisassociateClientDeviceFromCoreDeviceErrorEntry$message": "A message that provides additional information about the error.
", "GetComponentVersionArtifactRequest$artifactName": "The name of the artifact.
You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.
The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
The ID of the AWS IoT job that applies the deployment to target devices.
" + "GetDeploymentResponse$deploymentName": "The name of the deployment.
", + "GetDeploymentResponse$iotJobId": "The ID of the IoT job that applies the deployment to target devices.
" } }, "OptionalBoolean": { @@ -1003,8 +1022,8 @@ "refs": { "LambdaContainerParams$mountROSysfs": "Whether or not the container can read information from the device's /sys folder.
Default: false
Whether or not to add the component's system user as an owner of the device.
Default: false
Whether or not the Lambda function is pinned, or long-lived.
A pinned Lambda function starts when AWS IoT Greengrass starts and keeps running in its own container.
A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function.
Default: true
Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.
Default: false
Whether or not the Lambda function is pinned, or long-lived.
A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.
A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds. If the function has multiple work items, the IoT Greengrass Core software creates multiple instances of the function.
Default: true
Whether or not to add the IoT Greengrass user group as an owner of the volume.
Default: false
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
", + "LambdaExecutionParameters$maxQueueSize": "The maximum size of the message queue for the Lambda function component. The IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
", "LambdaExecutionParameters$maxInstancesCount": "The maximum number of instances that a non-pinned Lambda function can run at the same time.
", - "LambdaExecutionParameters$maxIdleTimeInSeconds": "The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process.
", + "LambdaExecutionParameters$maxIdleTimeInSeconds": "The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.
", "LambdaExecutionParameters$timeoutInSeconds": "The maximum amount of time in seconds that the Lambda function can process a work item.
", "LambdaExecutionParameters$statusTimeoutInSeconds": "The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
" } @@ -1023,7 +1042,7 @@ "PlatformAttributesMap": { "base": null, "refs": { - "ComponentPlatform$attributes": "A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
A dictionary of attributes for the platform. The IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
The format of the recipe.
" } }, + "RequestAlreadyInProgressException": { + "base": "The request is already in progress. This exception occurs when you use a client token for multiple requests while IoT Greengrass is still processing an earlier request that uses the same client token.
", + "refs": { + } + }, "ResolveComponentCandidatesRequest": { "base": null, "refs": { @@ -1064,7 +1088,7 @@ } }, "ResolvedComponentVersion": { - "base": "Contains information about a component version that is compatible to run on a AWS IoT Greengrass core device.
", + "base": "Contains information about a component version that is compatible to run on a Greengrass core device.
", "refs": { "ResolvedComponentVersionsList$member": null } @@ -1101,6 +1125,7 @@ "ConflictException$resourceType": "The type of the resource that conflicts with the request.
", "InternalServerException$message": null, "LambdaEnvironmentVariables$value": null, + "RequestAlreadyInProgressException$message": null, "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The ID of the resource that isn't found.
", "ResourceNotFoundException$resourceType": "The type of the resource that isn't found.
", @@ -1120,7 +1145,13 @@ "StringMap": { "base": null, "refs": { - "CloudComponentStatus$errors": "A dictionary of errors that communicate why the component is in an error state. For example, if AWS IoT Greengrass can't access an artifact for the component, then errors contains the artifact's URI as a key, and the error message as the value for that key.
A dictionary of errors that communicate why the component is in an error state. For example, if IoT Greengrass can't access an artifact for the component, then errors contains the artifact's URI as a key, and the error message as the value for that key.
Contains information about system resource limits that the IoT Greengrass Core software applies to a component's processes. For more information, see Configure system resource limits for components.
", + "refs": { + "ComponentRunWith$systemResourceLimits": "The system resource limits to apply to this component's process on the core device.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
" } }, "TagKey": { @@ -1139,14 +1170,14 @@ "TagMap": { "base": null, "refs": { - "CreateComponentVersionRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "CreateDeploymentRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "DescribeComponentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "GetComponentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "GetCoreDeviceResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "GetDeploymentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "ListTagsForResourceResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
", - "TagResourceRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "CreateComponentVersionRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "CreateDeploymentRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "DescribeComponentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "GetComponentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "GetCoreDeviceResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "GetDeploymentResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "ListTagsForResourceResponse$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
", + "TagResourceRequest$tags": "A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
" } }, "TagResourceRequest": { @@ -1168,17 +1199,17 @@ "TargetARN": { "base": null, "refs": { - "CreateDeploymentRequest$targetArn": "The ARN of the target AWS IoT thing or thing group.
", - "Deployment$targetArn": "The ARN of the target AWS IoT thing or thing group.
", - "EffectiveDeployment$targetArn": "The ARN of the target AWS IoT thing or thing group.
", - "GetDeploymentResponse$targetArn": "The ARN of the target AWS IoT thing or thing group.
", - "ListDeploymentsRequest$targetArn": "The ARN of the target AWS IoT thing or thing group.
" + "CreateDeploymentRequest$targetArn": "The ARN of the target IoT thing or thing group.
", + "Deployment$targetArn": "The ARN of the target IoT thing or thing group.
", + "EffectiveDeployment$targetArn": "The ARN of the target IoT thing or thing group.
", + "GetDeploymentResponse$targetArn": "The ARN of the target IoT thing or thing group.
", + "ListDeploymentsRequest$targetArn": "The ARN of the target IoT thing or thing group.
" } }, "ThingGroupARN": { "base": null, "refs": { - "ListCoreDevicesRequest$thingGroupArn": "The ARN of the AWS IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.
" + "ListCoreDevicesRequest$thingGroupArn": "The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.
" } }, "ThrottlingException": { diff --git a/models/apis/ssm-contacts/2021-05-03/api-2.json b/models/apis/ssm-contacts/2021-05-03/api-2.json index 3e8f559ecf..1f60f811ac 100644 --- a/models/apis/ssm-contacts/2021-05-03/api-2.json +++ b/models/apis/ssm-contacts/2021-05-03/api-2.json @@ -469,6 +469,13 @@ "min":6, "pattern":"^[0-9]*$" }, + "AcceptCodeValidation":{ + "type":"string", + "enum":[ + "IGNORE", + "ENFORCE" + ] + }, "AcceptPageRequest":{ "type":"structure", "required":[ @@ -481,7 +488,8 @@ "ContactChannelId":{"shape":"SsmContactsArn"}, "AcceptType":{"shape":"AcceptType"}, "Note":{"shape":"ReceiptInfo"}, - "AcceptCode":{"shape":"AcceptCode"} + "AcceptCode":{"shape":"AcceptCode"}, + "AcceptCodeValidation":{"shape":"AcceptCodeValidation"} } }, "AcceptPageResult":{ @@ -1299,7 +1307,7 @@ "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, - "max":200, + "max":50, "min":0 }, "TagResourceRequest":{ diff --git a/models/apis/ssm-contacts/2021-05-03/docs-2.json b/models/apis/ssm-contacts/2021-05-03/docs-2.json index 252a7277c8..bb22802a10 100644 --- a/models/apis/ssm-contacts/2021-05-03/docs-2.json +++ b/models/apis/ssm-contacts/2021-05-03/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "", + "service": "AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
", "operations": { "AcceptPage": "Used to acknowledge an engagement to a contact channel during an incident.
", "ActivateContactChannel": "Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
", @@ -37,6 +37,12 @@ "AcceptPageRequest$AcceptCode": "The accept code is a 6-digit code used to acknowledge the page.
" } }, + "AcceptCodeValidation": { + "base": null, + "refs": { + "AcceptPageRequest$AcceptCodeValidation": "An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.
Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.
The time to wait until beginning the next stage.
" + "Stage$DurationInMinutes": "The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
" } }, "StagesList": { diff --git a/service/greengrassv2/api.go b/service/greengrassv2/api.go index df250d8e4b..004b98cb8d 100644 --- a/service/greengrassv2/api.go +++ b/service/greengrassv2/api.go @@ -59,17 +59,17 @@ func (c *GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceRequest(input *Ba // // Associate a list of client devices with a core device. Use this API operation // to specify which client devices can discover a core device through cloud -// discovery. With cloud discovery, client devices connect to AWS IoT Greengrass +// discovery. With cloud discovery, client devices connect to IoT Greengrass // to retrieve associated core devices' connectivity information and certificates. // For more information, see Configure cloud discovery (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html) -// in the AWS IoT Greengrass V2 Developer Guide. +// in the IoT Greengrass V2 Developer Guide. // // Client devices are local IoT devices that connect to and communicate with -// an AWS IoT Greengrass core device over MQTT. You can connect client devices -// to a core device to sync MQTT messages and data to AWS IoT Core and interact -// with client devices in AWS IoT Greengrass components. For more information, +// an IoT Greengrass core device over MQTT. You can connect client devices to +// a core device to sync MQTT messages and data to Amazon Web Services IoT Core +// and interact with client devices in Greengrass components. For more information, // see Interact with local IoT devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) -// in the AWS IoT Greengrass V2 Developer Guide. +// in the IoT Greengrass V2 Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -90,7 +90,7 @@ func (c *GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceRequest(input *Ba // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -187,7 +187,7 @@ func (c *GreengrassV2) BatchDisassociateClientDeviceFromCoreDeviceRequest(input // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -283,7 +283,7 @@ func (c *GreengrassV2) CancelDeploymentRequest(input *CancelDeploymentInput) (re // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ConflictException // Your request has conflicting operations. This can occur if you're trying @@ -360,29 +360,29 @@ func (c *GreengrassV2) CreateComponentVersionRequest(input *CreateComponentVersi // CreateComponentVersion API operation for AWS IoT Greengrass V2. // -// Creates a component. Components are software that run on AWS IoT Greengrass -// core devices. After you develop and test a component on your core device, -// you can use this operation to upload your component to AWS IoT Greengrass. -// Then, you can deploy the component to other core devices. +// Creates a component. Components are software that run on Greengrass core +// devices. After you develop and test a component on your core device, you +// can use this operation to upload your component to IoT Greengrass. Then, +// you can deploy the component to other core devices. // // You can use this operation to do the following: // // * Create components from recipes Create a component from a recipe, which // is a file that defines the component's metadata, parameters, dependencies, // lifecycle, artifacts, and platform capability. For more information, see -// AWS IoT Greengrass component recipe reference (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) -// in the AWS IoT Greengrass V2 Developer Guide. To create a component from -// a recipe, specify inlineRecipe when you call this operation. -// -// * Create components from Lambda functions Create a component from an AWS -// Lambda function that runs on AWS IoT Greengrass. This creates a recipe -// and artifacts from the Lambda function's deployment package. You can use -// this operation to migrate Lambda functions from AWS IoT Greengrass V1 -// to AWS IoT Greengrass V2. This function only accepts Lambda functions -// that use the following runtimes: Python 2.7 – python2.7 Python 3.7 – -// python3.7 Python 3.8 – python3.8 Java 8 – java8 Node.js 10 – nodejs10.x -// Node.js 12 – nodejs12.x To create a component from a Lambda function, -// specify lambdaFunction when you call this operation. +// IoT Greengrass component recipe reference (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) +// in the IoT Greengrass V2 Developer Guide. To create a component from a +// recipe, specify inlineRecipe when you call this operation. +// +// * Create components from Lambda functions Create a component from an Lambda +// function that runs on IoT Greengrass. This creates a recipe and artifacts +// from the Lambda function's deployment package. You can use this operation +// to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. +// This function only accepts Lambda functions that use the following runtimes: +// Python 2.7 – python2.7 Python 3.7 – python3.7 Python 3.8 – python3.8 +// Java 8 – java8 Node.js 10 – nodejs10.x Node.js 12 – nodejs12.x To +// create a component from a Lambda function, specify lambdaFunction when +// you call this operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -413,7 +413,12 @@ func (c *GreengrassV2) CreateComponentVersionRequest(input *CreateComponentVersi // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. +// +// * RequestAlreadyInProgressException +// The request is already in progress. This exception occurs when you use a +// client token for multiple requests while IoT Greengrass is still processing +// an earlier request that uses the same client token. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateComponentVersion func (c *GreengrassV2) CreateComponentVersion(input *CreateComponentVersionInput) (*CreateComponentVersionOutput, error) { @@ -481,14 +486,14 @@ func (c *GreengrassV2) CreateDeploymentRequest(input *CreateDeploymentInput) (re // CreateDeployment API operation for AWS IoT Greengrass V2. // -// Creates a continuous deployment for a target, which is a AWS IoT Greengrass -// core device or group of core devices. When you add a new core device to a -// group of core devices that has a deployment, AWS IoT Greengrass deploys that -// group's deployment to the new device. +// Creates a continuous deployment for a target, which is a Greengrass core +// device or group of core devices. When you add a new core device to a group +// of core devices that has a deployment, IoT Greengrass deploys that group's +// deployment to the new device. // // You can define one deployment for each target. When you create a new deployment // for a target that has an existing deployment, you replace the previous deployment. -// AWS IoT Greengrass applies the new deployment to the target devices. +// IoT Greengrass applies the new deployment to the target devices. // // Every deployment has a revision number that indicates how many deployment // revisions you define for a target. Use this operation to create a new revision @@ -496,7 +501,7 @@ func (c *GreengrassV2) CreateDeploymentRequest(input *CreateDeploymentInput) (re // the new deployment when you create it. // // For more information, see the Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) -// in the AWS IoT Greengrass V2 Developer Guide. +// in the IoT Greengrass V2 Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -522,7 +527,12 @@ func (c *GreengrassV2) CreateDeploymentRequest(input *CreateDeploymentInput) (re // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. +// +// * RequestAlreadyInProgressException +// The request is already in progress. This exception occurs when you use a +// client token for multiple requests while IoT Greengrass is still processing +// an earlier request that uses the same client token. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateDeployment func (c *GreengrassV2) CreateDeployment(input *CreateDeploymentInput) (*CreateDeploymentOutput, error) { @@ -591,7 +601,7 @@ func (c *GreengrassV2) DeleteComponentRequest(input *DeleteComponentInput) (req // DeleteComponent API operation for AWS IoT Greengrass V2. // -// Deletes a version of a component from AWS IoT Greengrass. +// Deletes a version of a component from IoT Greengrass. // // This operation deletes the component's recipe and artifacts. As a result, // deployments that refer to this component version will fail. If you have deployments @@ -626,7 +636,7 @@ func (c *GreengrassV2) DeleteComponentRequest(input *DeleteComponentInput) (req // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteComponent func (c *GreengrassV2) DeleteComponent(input *DeleteComponentInput) (*DeleteComponentOutput, error) { @@ -695,11 +705,11 @@ func (c *GreengrassV2) DeleteCoreDeviceRequest(input *DeleteCoreDeviceInput) (re // DeleteCoreDevice API operation for AWS IoT Greengrass V2. // -// Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing. This -// operation removes the core device from the list of core devices. This operation -// doesn't delete the AWS IoT thing. For more information about how to delete -// the AWS IoT thing, see DeleteThing (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) -// in the AWS IoT API Reference. +// Deletes a Greengrass core device, which is an IoT thing. This operation removes +// the core device from the list of core devices. This operation doesn't delete +// the IoT thing. For more information about how to delete the IoT thing, see +// DeleteThing (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) +// in the IoT API Reference. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -720,7 +730,7 @@ func (c *GreengrassV2) DeleteCoreDeviceRequest(input *DeleteCoreDeviceInput) (re // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -823,7 +833,7 @@ func (c *GreengrassV2) DescribeComponentRequest(input *DescribeComponentInput) ( // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DescribeComponent func (c *GreengrassV2) DescribeComponent(input *DescribeComponentInput) (*DescribeComponentOutput, error) { @@ -918,7 +928,7 @@ func (c *GreengrassV2) GetComponentRequest(input *GetComponentInput) (req *reque // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponent func (c *GreengrassV2) GetComponent(input *GetComponentInput) (*GetComponentOutput, error) { @@ -1014,7 +1024,7 @@ func (c *GreengrassV2) GetComponentVersionArtifactRequest(input *GetComponentVer // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponentVersionArtifact func (c *GreengrassV2) GetComponentVersionArtifact(input *GetComponentVersionArtifactInput) (*GetComponentVersionArtifactOutput, error) { @@ -1082,7 +1092,7 @@ func (c *GreengrassV2) GetCoreDeviceRequest(input *GetCoreDeviceInput) (req *req // GetCoreDevice API operation for AWS IoT Greengrass V2. // -// Retrieves metadata for a AWS IoT Greengrass core device. +// Retrieves metadata for a Greengrass core device. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1103,7 +1113,7 @@ func (c *GreengrassV2) GetCoreDeviceRequest(input *GetCoreDeviceInput) (req *req // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -1176,8 +1186,8 @@ func (c *GreengrassV2) GetDeploymentRequest(input *GetDeploymentInput) (req *req // GetDeployment API operation for AWS IoT Greengrass V2. // -// Gets a deployment. Deployments define the components that run on AWS IoT -// Greengrass core devices. +// Gets a deployment. Deployments define the components that run on Greengrass +// core devices. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1198,7 +1208,7 @@ func (c *GreengrassV2) GetDeploymentRequest(input *GetDeploymentInput) (req *req // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -1299,7 +1309,7 @@ func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDeviceRequest(input *L // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -1457,7 +1467,7 @@ func (c *GreengrassV2) ListComponentVersionsRequest(input *ListComponentVersions // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponentVersions func (c *GreengrassV2) ListComponentVersions(input *ListComponentVersionsInput) (*ListComponentVersionsOutput, error) { @@ -1607,7 +1617,7 @@ func (c *GreengrassV2) ListComponentsRequest(input *ListComponentsInput) (req *r // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponents func (c *GreengrassV2) ListComponents(input *ListComponentsInput) (*ListComponentsOutput, error) { @@ -1733,7 +1743,7 @@ func (c *GreengrassV2) ListCoreDevicesRequest(input *ListCoreDevicesInput) (req // ListCoreDevices API operation for AWS IoT Greengrass V2. // -// Retrieves a paginated list of AWS IoT Greengrass core devices. +// Retrieves a paginated list of Greengrass core devices. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1751,7 +1761,7 @@ func (c *GreengrassV2) ListCoreDevicesRequest(input *ListCoreDevicesInput) (req // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -1900,7 +1910,7 @@ func (c *GreengrassV2) ListDeploymentsRequest(input *ListDeploymentsInput) (req // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -2031,8 +2041,8 @@ func (c *GreengrassV2) ListEffectiveDeploymentsRequest(input *ListEffectiveDeplo // ListEffectiveDeployments API operation for AWS IoT Greengrass V2. // -// Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends -// to AWS IoT Greengrass core devices. +// Retrieves a paginated list of deployment jobs that IoT Greengrass sends to +// Greengrass core devices. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2053,7 +2063,7 @@ func (c *GreengrassV2) ListEffectiveDeploymentsRequest(input *ListEffectiveDeplo // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -2184,8 +2194,8 @@ func (c *GreengrassV2) ListInstalledComponentsRequest(input *ListInstalledCompon // ListInstalledComponents API operation for AWS IoT Greengrass V2. // -// Retrieves a paginated list of the components that a AWS IoT Greengrass core -// device runs. +// Retrieves a paginated list of the components that a Greengrass core device +// runs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2206,7 +2216,7 @@ func (c *GreengrassV2) ListInstalledComponentsRequest(input *ListInstalledCompon // You don't have permission to perform the action. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ThrottlingException // Your request exceeded a request rate quota. For example, you might have exceeded @@ -2331,7 +2341,7 @@ func (c *GreengrassV2) ListTagsForResourceRequest(input *ListTagsForResourceInpu // ListTagsForResource API operation for AWS IoT Greengrass V2. // -// Retrieves the list of tags for an AWS IoT Greengrass resource. +// Retrieves the list of tags for an IoT Greengrass resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2342,7 +2352,7 @@ func (c *GreengrassV2) ListTagsForResourceRequest(input *ListTagsForResourceInpu // // Returned Error Types: // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ValidationException // The request isn't valid. This can occur if your request contains malformed @@ -2418,7 +2428,7 @@ func (c *GreengrassV2) ResolveComponentCandidatesRequest(input *ResolveComponent // ResolveComponentCandidates API operation for AWS IoT Greengrass V2. // // Retrieves a list of components that meet the component, version, and platform -// requirements of a deployment. AWS IoT Greengrass core devices call this operation +// requirements of a deployment. Greengrass core devices call this operation // when they receive a deployment to identify the components to install. // // This operation identifies components that meet all dependency requirements @@ -2427,13 +2437,13 @@ func (c *GreengrassV2) ResolveComponentCandidatesRequest(input *ResolveComponent // A requires version >2.0.0 and component B requires version <2.0.0 of a component // dependency. // -// When you specify the component candidates to resolve, AWS IoT Greengrass -// compares each component's digest from the core device with the component's -// digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass -// specifies to use the version from the AWS Cloud. +// When you specify the component candidates to resolve, IoT Greengrass compares +// each component's digest from the core device with the component's digest +// in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass +// specifies to use the version from the Amazon Web Services Cloud. // // To use this operation, you must use the data plane API endpoint and authenticate -// with an AWS IoT device certificate. For more information, see AWS IoT Greengrass +// with an IoT device certificate. For more information, see IoT Greengrass // endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/greengrass.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2460,7 +2470,7 @@ func (c *GreengrassV2) ResolveComponentCandidatesRequest(input *ResolveComponent // second. // // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ConflictException // Your request has conflicting operations. This can occur if you're trying @@ -2533,8 +2543,8 @@ func (c *GreengrassV2) TagResourceRequest(input *TagResourceInput) (req *request // TagResource API operation for AWS IoT Greengrass V2. // -// Adds tags to an AWS IoT Greengrass resource. If a tag already exists for -// the resource, this operation updates the tag's value. +// Adds tags to an IoT Greengrass resource. If a tag already exists for the +// resource, this operation updates the tag's value. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2545,7 +2555,7 @@ func (c *GreengrassV2) TagResourceRequest(input *TagResourceInput) (req *request // // Returned Error Types: // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ValidationException // The request isn't valid. This can occur if your request contains malformed @@ -2621,7 +2631,7 @@ func (c *GreengrassV2) UntagResourceRequest(input *UntagResourceInput) (req *req // UntagResource API operation for AWS IoT Greengrass V2. // -// Removes a tag from an AWS IoT Greengrass resource. +// Removes a tag from an IoT Greengrass resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2632,7 +2642,7 @@ func (c *GreengrassV2) UntagResourceRequest(input *UntagResourceInput) (req *req // // Returned Error Types: // * InternalServerException -// AWS IoT Greengrass can't process your request right now. Try again later. +// IoT Greengrass can't process your request right now. Try again later. // // * ValidationException // The request isn't valid. This can occur if your request contains malformed @@ -2725,7 +2735,7 @@ func (s *AccessDeniedException) RequestID() string { type AssociateClientDeviceWithCoreDeviceEntry struct { _ struct{} `type:"structure"` - // The name of the AWS IoT thing that represents the client device to associate. + // The name of the IoT thing that represents the client device to associate. // // ThingName is a required field ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"` @@ -2775,7 +2785,7 @@ type AssociateClientDeviceWithCoreDeviceErrorEntry struct { // A message that provides additional information about the error. Message *string `locationName:"message" min:"1" type:"string"` - // The name of the AWS IoT thing whose associate request failed. + // The name of the IoT thing whose associate request failed. ThingName *string `locationName:"thingName" min:"1" type:"string"` } @@ -2815,7 +2825,7 @@ type AssociatedClientDevice struct { // The time that the client device was associated, expressed in ISO 8601 format. AssociationTimestamp *time.Time `locationName:"associationTimestamp" type:"timestamp"` - // The name of the AWS IoT thing that represents the associated client device. + // The name of the IoT thing that represents the associated client device. ThingName *string `locationName:"thingName" min:"1" type:"string"` } @@ -2844,7 +2854,7 @@ func (s *AssociatedClientDevice) SetThingName(v string) *AssociatedClientDevice type BatchAssociateClientDeviceWithCoreDeviceInput struct { _ struct{} `type:"structure"` - // The name of the core device. This is also the name of the AWS IoT thing. + // The name of the core device. This is also the name of the IoT thing. // // CoreDeviceThingName is a required field CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"` @@ -2908,7 +2918,7 @@ type BatchAssociateClientDeviceWithCoreDeviceOutput struct { _ struct{} `type:"structure"` // The list of any errors for the entries in the request. Each error entry contains - // the name of the AWS IoT thing that failed to associate. + // the name of the IoT thing that failed to associate. ErrorEntries []*AssociateClientDeviceWithCoreDeviceErrorEntry `locationName:"errorEntries" min:"1" type:"list"` } @@ -2931,7 +2941,7 @@ func (s *BatchAssociateClientDeviceWithCoreDeviceOutput) SetErrorEntries(v []*As type BatchDisassociateClientDeviceFromCoreDeviceInput struct { _ struct{} `type:"structure"` - // The name of the core device. This is also the name of the AWS IoT thing. + // The name of the core device. This is also the name of the IoT thing. // // CoreDeviceThingName is a required field CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"` @@ -2995,7 +3005,7 @@ type BatchDisassociateClientDeviceFromCoreDeviceOutput struct { _ struct{} `type:"structure"` // The list of errors (if any) for the entries in the request. Each error entry - // contains the name of the AWS IoT thing that failed to disassociate. + // contains the name of the IoT thing that failed to disassociate. ErrorEntries []*DisassociateClientDeviceFromCoreDeviceErrorEntry `locationName:"errorEntries" min:"1" type:"list"` } @@ -3079,7 +3089,7 @@ func (s *CancelDeploymentOutput) SetMessage(v string) *CancelDeploymentOutput { return s } -// Contains the status of a component in the AWS IoT Greengrass service. +// Contains the status of a component in the IoT Greengrass service. type CloudComponentStatus struct { _ struct{} `type:"structure"` @@ -3087,9 +3097,9 @@ type CloudComponentStatus struct { ComponentState *string `locationName:"componentState" type:"string" enum:"CloudComponentState"` // A dictionary of errors that communicate why the component is in an error - // state. For example, if AWS IoT Greengrass can't access an artifact for the - // component, then errors contains the artifact's URI as a key, and the error - // message as the value for that key. + // state. For example, if IoT Greengrass can't access an artifact for the component, + // then errors contains the artifact's URI as a key, and the error message as + // the value for that key. Errors map[string]*string `locationName:"errors" type:"map"` // A message that communicates details, such as errors, about the status of @@ -3169,7 +3179,7 @@ func (s *Component) SetLatestVersion(v *ComponentLatestVersion) *Component { } // Contains information about a component that is a candidate to deploy to a -// AWS IoT Greengrass core device. +// Greengrass core device. type ComponentCandidate struct { _ struct{} `type:"structure"` @@ -3179,10 +3189,10 @@ type ComponentCandidate struct { // The version of the component. ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string"` - // The version requirements for the component's dependencies. AWS IoT Greengrass - // core devices get the version requirements from component recipes. + // The version requirements for the component's dependencies. Greengrass core + // devices get the version requirements from component recipes. // - // AWS IoT Greengrass V2 uses semantic version constraints. For more information, + // IoT Greengrass V2 uses semantic version constraints. For more information, // see Semantic Versioning (https://semver.org/). VersionRequirements map[string]*string `locationName:"versionRequirements" type:"map"` } @@ -3234,7 +3244,7 @@ func (s *ComponentCandidate) SetVersionRequirements(v map[string]*string) *Compo // Contains information about a deployment's update to a component's configuration // on Greengrass core devices. For more information, see Update component configurations // (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) -// in the AWS IoT Greengrass V2 Developer Guide. +// in the IoT Greengrass V2 Developer Guide. type ComponentConfigurationUpdate struct { _ struct{} `type:"structure"` @@ -3245,7 +3255,7 @@ type ComponentConfigurationUpdate struct { // default configuration. This means that the core device keeps it's existing // configuration for keys and values that you don't specify in this object. // For more information, see Merge configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) - // in the AWS IoT Greengrass V2 Developer Guide. + // in the IoT Greengrass V2 Developer Guide. Merge *string `locationName:"merge" min:"1" type:"string"` // The list of configuration nodes to reset to default values on target devices. @@ -3253,7 +3263,7 @@ type ComponentConfigurationUpdate struct { // a forward slash (/) and use forward slashes to separate the key for each // level in the object. For more information, see the JSON pointer specification // (https://tools.ietf.org/html/rfc6901) and Reset configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) - // in the AWS IoT Greengrass V2 Developer Guide. + // in the IoT Greengrass V2 Developer Guide. Reset []*string `locationName:"reset" type:"list"` } @@ -3307,7 +3317,7 @@ type ComponentDependencyRequirement struct { // The component version requirement for the component dependency. // - // AWS IoT Greengrass V2 uses semantic version constraints. For more information, + // IoT Greengrass V2 uses semantic version constraints. For more information, // see Semantic Versioning (https://semver.org/). VersionRequirement *string `locationName:"versionRequirement" min:"1" type:"string"` } @@ -3357,18 +3367,18 @@ type ComponentDeploymentSpecification struct { // The configuration updates to deploy for the component. You can define reset // updates and merge updates. A reset updates the keys that you specify to the // default configuration for the component. A merge updates the core device's - // component configuration with the keys and values that you specify. The AWS - // IoT Greengrass Core software applies reset updates before it applies merge - // updates. For more information, see Update component configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) - // in the AWS IoT Greengrass V2 Developer Guide. + // component configuration with the keys and values that you specify. The IoT + // Greengrass Core software applies reset updates before it applies merge updates. + // For more information, see Update component configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) + // in the IoT Greengrass V2 Developer Guide. ConfigurationUpdate *ComponentConfigurationUpdate `locationName:"configurationUpdate" type:"structure"` - // The system user and group that the AWS IoT Greengrass Core software uses - // to run component processes on the core device. If you omit this parameter, - // the AWS IoT Greengrass Core software uses the system user and group that - // you configure for the core device. For more information, see Configure the - // user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) - // in the AWS IoT Greengrass V2 Developer Guide. + // The system user and group that the IoT Greengrass Core software uses to run + // component processes on the core device. If you omit this parameter, the IoT + // Greengrass Core software uses the system user and group that you configure + // for the core device. For more information, see Configure the user and group + // that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) + // in the IoT Greengrass V2 Developer Guide. RunWith *ComponentRunWith `locationName:"runWith" type:"structure"` } @@ -3497,18 +3507,17 @@ func (s *ComponentLatestVersion) SetPublisher(v string) *ComponentLatestVersion type ComponentPlatform struct { _ struct{} `type:"structure"` - // A dictionary of attributes for the platform. The AWS IoT Greengrass Core - // software defines the os and platform by default. You can specify additional - // platform attributes for a core device when you deploy the AWS IoT Greengrass - // nucleus component. For more information, see the AWS IoT Greengrass nucleus - // component (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) - // in the AWS IoT Greengrass V2 Developer Guide. + // A dictionary of attributes for the platform. The IoT Greengrass Core software + // defines the os and platform by default. You can specify additional platform + // attributes for a core device when you deploy the Greengrass nucleus component. + // For more information, see the Greengrass nucleus component (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) + // in the IoT Greengrass V2 Developer Guide. Attributes map[string]*string `locationName:"attributes" type:"map"` // The friendly name of the platform. This name helps you identify the platform. // - // If you omit this parameter, AWS IoT Greengrass creates a friendly name from - // the os and architecture of the platform. + // If you omit this parameter, IoT Greengrass creates a friendly name from the + // os and architecture of the platform. Name *string `locationName:"name" min:"1" type:"string"` } @@ -3547,18 +3556,32 @@ func (s *ComponentPlatform) SetName(v string) *ComponentPlatform { return s } -// Contains information system user and group that the AWS IoT Greengrass Core -// software uses to run component processes on the core device. For more information, +// Contains information system user and group that the IoT Greengrass Core software +// uses to run component processes on the core device. For more information, // see Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) -// in the AWS IoT Greengrass V2 Developer Guide. +// in the IoT Greengrass V2 Developer Guide. type ComponentRunWith struct { _ struct{} `type:"structure"` // The POSIX system user and (optional) group to use to run this component. // Specify the user and group separated by a colon (:) in the following format: - // user:group. The group is optional. If you don't specify a group, the AWS - // IoT Greengrass Core software uses the primary user for the group. + // user:group. The group is optional. If you don't specify a group, the IoT + // Greengrass Core software uses the primary user for the group. + // + // If you omit this parameter, the IoT Greengrass Core software uses the default + // system user and group that you configure on the Greengrass nucleus component. + // For more information, see Configure the user and group that run components + // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user). PosixUser *string `locationName:"posixUser" min:"1" type:"string"` + + // The system resource limits to apply to this component's process on the core + // device. + // + // If you omit this parameter, the IoT Greengrass Core software uses the default + // system resource limits that you configure on the Greengrass nucleus component. + // For more information, see Configure system resource limits for components + // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits). + SystemResourceLimits *SystemResourceLimits `locationName:"systemResourceLimits" type:"structure"` } // String returns the string representation @@ -3590,6 +3613,12 @@ func (s *ComponentRunWith) SetPosixUser(v string) *ComponentRunWith { return s } +// SetSystemResourceLimits sets the SystemResourceLimits field's value. +func (s *ComponentRunWith) SetSystemResourceLimits(v *SystemResourceLimits) *ComponentRunWith { + s.SystemResourceLimits = v + return s +} + // Contains information about a component version in a list. type ComponentVersionListItem struct { _ struct{} `type:"structure"` @@ -3700,12 +3729,12 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// Contains information about a AWS IoT Greengrass core device, which is an -// AWS IoT thing that runs the AWS IoT Greengrass Core software. +// Contains information about a Greengrass core device, which is an IoT thing +// that runs the IoT Greengrass Core software. type CoreDevice struct { _ struct{} `type:"structure"` - // The name of the core device. This is also the name of the AWS IoT thing. + // The name of the core device. This is also the name of the IoT thing. CoreDeviceThingName *string `locationName:"coreDeviceThingName" min:"1" type:"string"` // The time at which the core device's status last updated, expressed in ISO @@ -3714,11 +3743,11 @@ type CoreDevice struct { // The status of the core device. Core devices can have the following statuses: // - // * HEALTHY – The AWS IoT Greengrass Core software and all components - // run on the core device without issue. + // * HEALTHY – The IoT Greengrass Core software and all components run + // on the core device without issue. // - // * UNHEALTHY – The AWS IoT Greengrass Core software or a component is - // in a failed state on the core device. + // * UNHEALTHY – The IoT Greengrass Core software or a component is in + // a failed state on the core device. Status *string `locationName:"status" type:"string" enum:"CoreDeviceStatus"` } @@ -3753,6 +3782,15 @@ func (s *CoreDevice) SetStatus(v string) *CoreDevice { type CreateComponentVersionInput struct { _ struct{} `type:"structure"` + // A unique, case-sensitive identifier that you can provide to ensure that the + // request is idempotent. Idempotency means that the request is successfully + // processed only once, even if you send the request multiple times. When a + // request succeeds, and you specify the same client token for subsequent successful + // requests, the IoT Greengrass V2 service returns the successful response that + // it caches from the previous request. IoT Greengrass V2 caches successful + // responses for idempotent requests for up to 8 hours. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + // The recipe to use to create the component. The recipe defines the component's // metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. // @@ -3768,7 +3806,7 @@ type CreateComponentVersionInput struct { // A list of key-value pairs that contain metadata for the resource. For more // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) - // in the AWS IoT Greengrass V2 Developer Guide. + // in the IoT Greengrass V2 Developer Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` } @@ -3785,6 +3823,9 @@ func (s CreateComponentVersionInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateComponentVersionInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateComponentVersionInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } if s.Tags != nil && len(s.Tags) < 1 { invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) } @@ -3800,6 +3841,12 @@ func (s *CreateComponentVersionInput) Validate() error { return nil } +// SetClientToken sets the ClientToken field's value. +func (s *CreateComponentVersionInput) SetClientToken(v string) *CreateComponentVersionInput { + s.ClientToken = &v + return s +} + // SetInlineRecipe sets the InlineRecipe field's value. func (s *CreateComponentVersionInput) SetInlineRecipe(v []byte) *CreateComponentVersionInput { s.InlineRecipe = v @@ -3840,8 +3887,8 @@ type CreateComponentVersionOutput struct { // CreationTimestamp is a required field CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp" required:"true"` - // The status of the component version in AWS IoT Greengrass V2. This status - // is different from the status of the component on a core device. + // The status of the component version in IoT Greengrass V2. This status is + // different from the status of the component on a core device. // // Status is a required field Status *CloudComponentStatus `locationName:"status" type:"structure" required:"true"` @@ -3890,16 +3937,21 @@ func (s *CreateComponentVersionOutput) SetStatus(v *CloudComponentStatus) *Creat type CreateDeploymentInput struct { _ struct{} `type:"structure"` + // A unique, case-sensitive identifier that you can provide to ensure that the + // request is idempotent. Idempotency means that the request is successfully + // processed only once, even if you send the request multiple times. When a + // request succeeds, and you specify the same client token for subsequent successful + // requests, the IoT Greengrass V2 service returns the successful response that + // it caches from the previous request. IoT Greengrass V2 caches successful + // responses for idempotent requests for up to 8 hours. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + // The components to deploy. This is a dictionary, where each key is the name // of a component, and each key's value is the version and configuration to // deploy for that component. Components map[string]*ComponentDeploymentSpecification `locationName:"components" type:"map"` // The name of the deployment. - // - // You can create deployments without names. If you create a deployment without - // a name, the AWS IoT Greengrass V2 console shows the deployment name as