| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.GreengrassV2.ResolveComponentCandidates
Description
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.
Synopsis
- data ResolveComponentCandidates = ResolveComponentCandidates' {}
- newResolveComponentCandidates :: ResolveComponentCandidates
- resolveComponentCandidates_componentCandidates :: Lens' ResolveComponentCandidates (Maybe [ComponentCandidate])
- resolveComponentCandidates_platform :: Lens' ResolveComponentCandidates (Maybe ComponentPlatform)
- data ResolveComponentCandidatesResponse = ResolveComponentCandidatesResponse' {}
- newResolveComponentCandidatesResponse :: Int -> ResolveComponentCandidatesResponse
- resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens' ResolveComponentCandidatesResponse (Maybe [ResolvedComponentVersion])
- resolveComponentCandidatesResponse_httpStatus :: Lens' ResolveComponentCandidatesResponse Int
Creating a Request
data ResolveComponentCandidates Source #
See: newResolveComponentCandidates smart constructor.
Constructors
| ResolveComponentCandidates' | |
Fields
| |
Instances
newResolveComponentCandidates :: ResolveComponentCandidates Source #
Create a value of ResolveComponentCandidates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentCandidates:ResolveComponentCandidates', resolveComponentCandidates_componentCandidates - The list of components to resolve.
$sel:platform:ResolveComponentCandidates', resolveComponentCandidates_platform - The platform to use to resolve compatible components.
Request Lenses
resolveComponentCandidates_componentCandidates :: Lens' ResolveComponentCandidates (Maybe [ComponentCandidate]) Source #
The list of components to resolve.
resolveComponentCandidates_platform :: Lens' ResolveComponentCandidates (Maybe ComponentPlatform) Source #
The platform to use to resolve compatible components.
Destructuring the Response
data ResolveComponentCandidatesResponse Source #
See: newResolveComponentCandidatesResponse smart constructor.
Constructors
| ResolveComponentCandidatesResponse' | |
Fields
| |
Instances
newResolveComponentCandidatesResponse Source #
Arguments
| :: Int | |
| -> ResolveComponentCandidatesResponse |
Create a value of ResolveComponentCandidatesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resolvedComponentVersions:ResolveComponentCandidatesResponse', resolveComponentCandidatesResponse_resolvedComponentVersions - A list of components that meet the requirements that you specify in the
request. This list includes each component's recipe that you can use to
install the component.
$sel:httpStatus:ResolveComponentCandidatesResponse', resolveComponentCandidatesResponse_httpStatus - The response's http status code.
Response Lenses
resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens' ResolveComponentCandidatesResponse (Maybe [ResolvedComponentVersion]) Source #
A list of components that meet the requirements that you specify in the request. This list includes each component's recipe that you can use to install the component.
resolveComponentCandidatesResponse_httpStatus :: Lens' ResolveComponentCandidatesResponse Int Source #
The response's http status code.