Current section
Files
Jump to
Current section
Files
src/aws_greengrassv2.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc 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.
-module(aws_greengrassv2).
-export([associate_service_role_to_account/2,
associate_service_role_to_account/3,
batch_associate_client_device_with_core_device/3,
batch_associate_client_device_with_core_device/4,
batch_disassociate_client_device_from_core_device/3,
batch_disassociate_client_device_from_core_device/4,
cancel_deployment/3,
cancel_deployment/4,
create_component_version/2,
create_component_version/3,
create_deployment/2,
create_deployment/3,
delete_component/3,
delete_component/4,
delete_core_device/3,
delete_core_device/4,
delete_deployment/3,
delete_deployment/4,
describe_component/2,
describe_component/4,
describe_component/5,
disassociate_service_role_from_account/2,
disassociate_service_role_from_account/3,
get_component/2,
get_component/4,
get_component/5,
get_component_version_artifact/3,
get_component_version_artifact/5,
get_component_version_artifact/6,
get_connectivity_info/2,
get_connectivity_info/4,
get_connectivity_info/5,
get_core_device/2,
get_core_device/4,
get_core_device/5,
get_deployment/2,
get_deployment/4,
get_deployment/5,
get_service_role_for_account/1,
get_service_role_for_account/3,
get_service_role_for_account/4,
list_client_devices_associated_with_core_device/2,
list_client_devices_associated_with_core_device/4,
list_client_devices_associated_with_core_device/5,
list_component_versions/2,
list_component_versions/4,
list_component_versions/5,
list_components/1,
list_components/3,
list_components/4,
list_core_devices/1,
list_core_devices/3,
list_core_devices/4,
list_deployments/1,
list_deployments/3,
list_deployments/4,
list_effective_deployments/2,
list_effective_deployments/4,
list_effective_deployments/5,
list_installed_components/2,
list_installed_components/4,
list_installed_components/5,
list_tags_for_resource/2,
list_tags_for_resource/4,
list_tags_for_resource/5,
resolve_component_candidates/2,
resolve_component_candidates/3,
tag_resource/3,
tag_resource/4,
untag_resource/3,
untag_resource/4,
update_connectivity_info/3,
update_connectivity_info/4]).
-include_lib("hackney/include/hackney_lib.hrl").
%%====================================================================
%% API
%%====================================================================
%% @doc Associates a Greengrass service role with IoT Greengrass for your
%% Amazon Web Services account in this Amazon Web Services Region.
%%
%% IoT Greengrass uses this role to verify the identity of client devices and
%% manage core device connectivity information. The role must include the
%% AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy
%% that defines equivalent permissions for the IoT Greengrass features that
%% you use. For more information, see Greengrass service role in the IoT
%% Greengrass Version 2 Developer Guide.
associate_service_role_to_account(Client, Input) ->
associate_service_role_to_account(Client, Input, []).
associate_service_role_to_account(Client, Input0, Options0) ->
Method = put,
Path = ["/greengrass/servicerole"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Associates 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.
batch_associate_client_device_with_core_device(Client, CoreDeviceThingName, Input) ->
batch_associate_client_device_with_core_device(Client, CoreDeviceThingName, Input, []).
batch_associate_client_device_with_core_device(Client, CoreDeviceThingName, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), "/associateClientDevices"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Disassociates 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.
batch_disassociate_client_device_from_core_device(Client, CoreDeviceThingName, Input) ->
batch_disassociate_client_device_from_core_device(Client, CoreDeviceThingName, Input, []).
batch_disassociate_client_device_from_core_device(Client, CoreDeviceThingName, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), "/disassociateClientDevices"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc 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.
cancel_deployment(Client, DeploymentId, Input) ->
cancel_deployment(Client, DeploymentId, Input, []).
cancel_deployment(Client, DeploymentId, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/deployments/", aws_util:encode_uri(DeploymentId), "/cancel"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc 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:
%%
%% <ul> <li> 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.
%%
%% </li> <li> 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:
%%
%% <ul> <li> Python 2.7 – `python2.7'
%%
%% </li> <li> Python 3.7 – `python3.7'
%%
%% </li> <li> Python 3.8 – `python3.8'
%%
%% </li> <li> Python 3.9 – `python3.9'
%%
%% </li> <li> Java 8 – `java8'
%%
%% </li> <li> Java 11 – `java11'
%%
%% </li> <li> Node.js 10 – `nodejs10.x'
%%
%% </li> <li> Node.js 12 – `nodejs12.x'
%%
%% </li> <li> Node.js 14 – `nodejs14.x'
%%
%% </li> </ul> To create a component from a Lambda function, specify
%% `lambdaFunction' when you call this operation.
%%
%% IoT Greengrass currently supports Lambda functions on only Linux core
%% devices.
%%
%% </li> </ul>
create_component_version(Client, Input) ->
create_component_version(Client, Input, []).
create_component_version(Client, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/createComponentVersion"],
SuccessStatusCode = 201,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc 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.
%%
%% For more information, see the Create deployments in the IoT Greengrass V2
%% Developer Guide.
create_deployment(Client, Input) ->
create_deployment(Client, Input, []).
create_deployment(Client, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/deployments"],
SuccessStatusCode = 201,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc 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.
delete_component(Client, Arn, Input) ->
delete_component(Client, Arn, Input, []).
delete_component(Client, Arn, Input0, Options0) ->
Method = delete,
Path = ["/greengrass/v2/components/", aws_util:encode_uri(Arn), ""],
SuccessStatusCode = 204,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc 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.
delete_core_device(Client, CoreDeviceThingName, Input) ->
delete_core_device(Client, CoreDeviceThingName, Input, []).
delete_core_device(Client, CoreDeviceThingName, Input0, Options0) ->
Method = delete,
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), ""],
SuccessStatusCode = 204,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Deletes a deployment.
%%
%% To delete an active deployment, you must first cancel it. For more
%% information, see CancelDeployment.
%%
%% Deleting a deployment doesn't affect core devices that run that
%% deployment, because core devices store the deployment's configuration on
%% the device. Additionally, core devices can roll back to a previous
%% deployment that has been deleted.
delete_deployment(Client, DeploymentId, Input) ->
delete_deployment(Client, DeploymentId, Input, []).
delete_deployment(Client, DeploymentId, Input0, Options0) ->
Method = delete,
Path = ["/greengrass/v2/deployments/", aws_util:encode_uri(DeploymentId), ""],
SuccessStatusCode = 204,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Retrieves metadata for a version of a component.
describe_component(Client, Arn)
when is_map(Client) ->
describe_component(Client, Arn, #{}, #{}).
describe_component(Client, Arn, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
describe_component(Client, Arn, QueryMap, HeadersMap, []).
describe_component(Client, Arn, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/components/", aws_util:encode_uri(Arn), "/metadata"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Disassociates the Greengrass service role from IoT Greengrass for
%% your Amazon Web Services account in this Amazon Web Services Region.
%%
%% Without a service role, IoT Greengrass can't verify the identity of client
%% devices or manage core device connectivity information. For more
%% information, see Greengrass service role in the IoT Greengrass Version 2
%% Developer Guide.
disassociate_service_role_from_account(Client, Input) ->
disassociate_service_role_from_account(Client, Input, []).
disassociate_service_role_from_account(Client, Input0, Options0) ->
Method = delete,
Path = ["/greengrass/servicerole"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Gets the recipe for a version of a component.
get_component(Client, Arn)
when is_map(Client) ->
get_component(Client, Arn, #{}, #{}).
get_component(Client, Arn, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_component(Client, Arn, QueryMap, HeadersMap, []).
get_component(Client, Arn, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/components/", aws_util:encode_uri(Arn), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"recipeOutputFormat">>, maps:get(<<"recipeOutputFormat">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Gets the pre-signed URL to download a public or a Lambda component
%% artifact.
%%
%% Core devices call this operation to identify the URL that they can use to
%% download an artifact to install.
get_component_version_artifact(Client, Arn, ArtifactName)
when is_map(Client) ->
get_component_version_artifact(Client, Arn, ArtifactName, #{}, #{}).
get_component_version_artifact(Client, Arn, ArtifactName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_component_version_artifact(Client, Arn, ArtifactName, QueryMap, HeadersMap, []).
get_component_version_artifact(Client, Arn, ArtifactName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/components/", aws_util:encode_uri(Arn), "/artifacts/", aws_util:encode_multi_segment_uri(ArtifactName), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves connectivity information for a Greengrass core device.
%%
%% Connectivity information includes endpoints and ports where client devices
%% can connect to an MQTT broker on the core device. When a client device
%% calls the IoT Greengrass discovery API, IoT Greengrass returns
%% connectivity information for all of the core devices where the client
%% device can connect. For more information, see Connect client devices to
%% core devices in the IoT Greengrass Version 2 Developer Guide.
get_connectivity_info(Client, ThingName)
when is_map(Client) ->
get_connectivity_info(Client, ThingName, #{}, #{}).
get_connectivity_info(Client, ThingName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_connectivity_info(Client, ThingName, QueryMap, HeadersMap, []).
get_connectivity_info(Client, ThingName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/things/", aws_util:encode_uri(ThingName), "/connectivityInfo"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves metadata for a Greengrass core device.
%%
%% IoT Greengrass relies on individual devices to send status updates to the
%% Amazon Web Services Cloud. If the IoT Greengrass Core software isn't
%% running on the device, or if device isn't connected to the Amazon Web
%% Services Cloud, then the reported status of that device might not reflect
%% its current status. The status timestamp indicates when the device status
%% was last updated.
%%
%% Core devices send status updates at the following times:
%%
%% When the IoT Greengrass Core software starts
%%
%% When the core device receives a deployment from the Amazon Web Services
%% Cloud
%%
%% When the status of any component on the core device becomes `BROKEN'
%%
%% At a regular interval that you can configure, which defaults to 24 hours
%%
%% For IoT Greengrass Core v2.7.0, the core device sends status updates upon
%% local deployment and cloud deployment
get_core_device(Client, CoreDeviceThingName)
when is_map(Client) ->
get_core_device(Client, CoreDeviceThingName, #{}, #{}).
get_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap, []).
get_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Gets a deployment.
%%
%% Deployments define the components that run on Greengrass core devices.
get_deployment(Client, DeploymentId)
when is_map(Client) ->
get_deployment(Client, DeploymentId, #{}, #{}).
get_deployment(Client, DeploymentId, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_deployment(Client, DeploymentId, QueryMap, HeadersMap, []).
get_deployment(Client, DeploymentId, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/deployments/", aws_util:encode_uri(DeploymentId), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Gets the service role associated with IoT Greengrass for your Amazon
%% Web Services account in this Amazon Web Services Region.
%%
%% IoT Greengrass uses this role to verify the identity of client devices and
%% manage core device connectivity information. For more information, see
%% Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
get_service_role_for_account(Client)
when is_map(Client) ->
get_service_role_for_account(Client, #{}, #{}).
get_service_role_for_account(Client, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
get_service_role_for_account(Client, QueryMap, HeadersMap, []).
get_service_role_for_account(Client, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/servicerole"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of client devices that are associated with
%% a core device.
list_client_devices_associated_with_core_device(Client, CoreDeviceThingName)
when is_map(Client) ->
list_client_devices_associated_with_core_device(Client, CoreDeviceThingName, #{}, #{}).
list_client_devices_associated_with_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_client_devices_associated_with_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap, []).
list_client_devices_associated_with_core_device(Client, CoreDeviceThingName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), "/associatedClientDevices"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of all versions for a component.
%%
%% Greater versions are listed first.
list_component_versions(Client, Arn)
when is_map(Client) ->
list_component_versions(Client, Arn, #{}, #{}).
list_component_versions(Client, Arn, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_component_versions(Client, Arn, QueryMap, HeadersMap, []).
list_component_versions(Client, Arn, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/components/", aws_util:encode_uri(Arn), "/versions"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of component summaries.
%%
%% This list includes components that you have permission to view.
list_components(Client)
when is_map(Client) ->
list_components(Client, #{}, #{}).
list_components(Client, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_components(Client, QueryMap, HeadersMap, []).
list_components(Client, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/components"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)},
{<<"scope">>, maps:get(<<"scope">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of Greengrass core devices.
%%
%% IoT Greengrass relies on individual devices to send status updates to the
%% Amazon Web Services Cloud. If the IoT Greengrass Core software isn't
%% running on the device, or if device isn't connected to the Amazon Web
%% Services Cloud, then the reported status of that device might not reflect
%% its current status. The status timestamp indicates when the device status
%% was last updated.
%%
%% Core devices send status updates at the following times:
%%
%% When the IoT Greengrass Core software starts
%%
%% When the core device receives a deployment from the Amazon Web Services
%% Cloud
%%
%% When the status of any component on the core device becomes `BROKEN'
%%
%% At a regular interval that you can configure, which defaults to 24 hours
%%
%% For IoT Greengrass Core v2.7.0, the core device sends status updates upon
%% local deployment and cloud deployment
list_core_devices(Client)
when is_map(Client) ->
list_core_devices(Client, #{}, #{}).
list_core_devices(Client, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_core_devices(Client, QueryMap, HeadersMap, []).
list_core_devices(Client, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/coreDevices"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)},
{<<"status">>, maps:get(<<"status">>, QueryMap, undefined)},
{<<"thingGroupArn">>, maps:get(<<"thingGroupArn">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of deployments.
list_deployments(Client)
when is_map(Client) ->
list_deployments(Client, #{}, #{}).
list_deployments(Client, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_deployments(Client, QueryMap, HeadersMap, []).
list_deployments(Client, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/deployments"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"historyFilter">>, maps:get(<<"historyFilter">>, QueryMap, undefined)},
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)},
{<<"parentTargetArn">>, maps:get(<<"parentTargetArn">>, QueryMap, undefined)},
{<<"targetArn">>, maps:get(<<"targetArn">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of deployment jobs that IoT Greengrass
%% sends to Greengrass core devices.
list_effective_deployments(Client, CoreDeviceThingName)
when is_map(Client) ->
list_effective_deployments(Client, CoreDeviceThingName, #{}, #{}).
list_effective_deployments(Client, CoreDeviceThingName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_effective_deployments(Client, CoreDeviceThingName, QueryMap, HeadersMap, []).
list_effective_deployments(Client, CoreDeviceThingName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), "/effectiveDeployments"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves a paginated list of the components that a Greengrass core
%% device runs.
%%
%% By default, this list doesn't include components that are deployed as
%% dependencies of other components. To include dependencies in the response,
%% set the `topologyFilter' parameter to `ALL'.
%%
%% IoT Greengrass relies on individual devices to send status updates to the
%% Amazon Web Services Cloud. If the IoT Greengrass Core software isn't
%% running on the device, or if device isn't connected to the Amazon Web
%% Services Cloud, then the reported status of that device might not reflect
%% its current status. The status timestamp indicates when the device status
%% was last updated.
%%
%% Core devices send status updates at the following times:
%%
%% When the IoT Greengrass Core software starts
%%
%% When the core device receives a deployment from the Amazon Web Services
%% Cloud
%%
%% When the status of any component on the core device becomes `BROKEN'
%%
%% At a regular interval that you can configure, which defaults to 24 hours
%%
%% For IoT Greengrass Core v2.7.0, the core device sends status updates upon
%% local deployment and cloud deployment
list_installed_components(Client, CoreDeviceThingName)
when is_map(Client) ->
list_installed_components(Client, CoreDeviceThingName, #{}, #{}).
list_installed_components(Client, CoreDeviceThingName, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_installed_components(Client, CoreDeviceThingName, QueryMap, HeadersMap, []).
list_installed_components(Client, CoreDeviceThingName, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/greengrass/v2/coreDevices/", aws_util:encode_uri(CoreDeviceThingName), "/installedComponents"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query0_ =
[
{<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)},
{<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)},
{<<"topologyFilter">>, maps:get(<<"topologyFilter">>, QueryMap, undefined)}
],
Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc Retrieves the list of tags for an IoT Greengrass resource.
list_tags_for_resource(Client, ResourceArn)
when is_map(Client) ->
list_tags_for_resource(Client, ResourceArn, #{}, #{}).
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, []).
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
Path = ["/tags/", aws_util:encode_uri(ResourceArn), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false}
| Options0],
Headers = [],
Query_ = [],
request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode).
%% @doc 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.
resolve_component_candidates(Client, Input) ->
resolve_component_candidates(Client, Input, []).
resolve_component_candidates(Client, Input0, Options0) ->
Method = post,
Path = ["/greengrass/v2/resolveComponentCandidates"],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Adds tags to an IoT Greengrass resource.
%%
%% If a tag already exists for the resource, this operation updates the tag's
%% value.
tag_resource(Client, ResourceArn, Input) ->
tag_resource(Client, ResourceArn, Input, []).
tag_resource(Client, ResourceArn, Input0, Options0) ->
Method = post,
Path = ["/tags/", aws_util:encode_uri(ResourceArn), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Removes a tag from an IoT Greengrass resource.
untag_resource(Client, ResourceArn, Input) ->
untag_resource(Client, ResourceArn, Input, []).
untag_resource(Client, ResourceArn, Input0, Options0) ->
Method = delete,
Path = ["/tags/", aws_util:encode_uri(ResourceArn), ""],
SuccessStatusCode = undefined,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
QueryMapping = [
{<<"tagKeys">>, <<"tagKeys">>}
],
{Query_, Input} = aws_request:build_headers(QueryMapping, Input2),
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Updates connectivity information for a Greengrass core device.
%%
%% Connectivity information includes endpoints and ports where client devices
%% can connect to an MQTT broker on the core device. When a client device
%% calls the IoT Greengrass discovery API, IoT Greengrass returns
%% connectivity information for all of the core devices where the client
%% device can connect. For more information, see Connect client devices to
%% core devices in the IoT Greengrass Version 2 Developer Guide.
update_connectivity_info(Client, ThingName, Input) ->
update_connectivity_info(Client, ThingName, Input, []).
update_connectivity_info(Client, ThingName, Input0, Options0) ->
Method = put,
Path = ["/greengrass/things/", aws_util:encode_uri(ThingName), "/connectivityInfo"],
SuccessStatusCode = 200,
Options = [{send_body_as_binary, false},
{receive_body_as_binary, false},
{append_sha256_content_hash, false}
| Options0],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%%====================================================================
%% Internal functions
%%====================================================================
-spec request(aws_client:aws_client(), atom(), iolist(), list(),
list(), map() | undefined, list(), pos_integer() | undefined) ->
{ok, {integer(), list()}} |
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map(),
Error :: map().
request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
RequestFun = fun() -> do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) end,
aws_request:request(RequestFun, Options).
do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
Client1 = Client#{service => <<"greengrass">>},
Host = build_host(<<"greengrass">>, Client1),
URL0 = build_url(Host, Path, Client1),
URL = aws_request:add_query(URL0, Query),
AdditionalHeaders1 = [ {<<"Host">>, Host}
, {<<"Content-Type">>, <<"application/x-amz-json-1.1">>}
],
Payload =
case proplists:get_value(send_body_as_binary, Options) of
true ->
maps:get(<<"Body">>, Input, <<"">>);
false ->
encode_payload(Input)
end,
AdditionalHeaders = case proplists:get_value(append_sha256_content_hash, Options) of
true ->
add_checksum_hash_header(AdditionalHeaders1, Payload);
false ->
AdditionalHeaders1
end,
Headers1 = aws_request:add_headers(AdditionalHeaders, Headers0),
MethodBin = aws_request:method_to_binary(Method),
SignedHeaders = aws_request:sign_request(Client1, MethodBin, URL, Headers1, Payload),
Response = hackney:request(Method, URL, SignedHeaders, Payload, Options),
DecodeBody = not proplists:get_value(receive_body_as_binary, Options),
handle_response(Response, SuccessStatusCode, DecodeBody).
add_checksum_hash_header(Headers, Body) ->
[ {<<"X-Amz-CheckSum-SHA256">>, base64:encode(crypto:hash(sha256, Body))}
| Headers
].
handle_response({ok, StatusCode, ResponseHeaders}, SuccessStatusCode, _DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
{ok, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders}, _, _DecodeBody) ->
{error, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders, Client}, SuccessStatusCode, DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
case hackney:body(Client) of
{ok, <<>>} when StatusCode =:= 200;
StatusCode =:= SuccessStatusCode ->
{ok, #{}, {StatusCode, ResponseHeaders, Client}};
{ok, Body} ->
Result = case DecodeBody of
true ->
try
jsx:decode(Body)
catch
Error:Reason:Stack ->
erlang:raise(error, {body_decode_failed, Error, Reason, StatusCode, Body}, Stack)
end;
false -> #{<<"Body">> => Body}
end,
{ok, Result, {StatusCode, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, ResponseHeaders, Client}, _, _DecodeBody) ->
{ok, Body} = hackney:body(Client),
Error = jsx:decode(Body),
{error, Error, {StatusCode, ResponseHeaders, Client}};
handle_response({error, Reason}, _, _DecodeBody) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Path0, Client) ->
Proto = maps:get(proto, Client),
Path = erlang:iolist_to_binary(Path0),
Port = maps:get(port, Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, Path], <<"">>).
-spec encode_payload(undefined | map()) -> binary().
encode_payload(undefined) ->
<<>>;
encode_payload(Input) ->
jsx:encode(Input).