lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.23.0 vs lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.24.0

- old
+ new

@@ -258,22 +258,23 @@ # to access AWS cloud services. The role's permissions should allow # Greengrass core Lambda functions to perform actions against the cloud. # # @option params [required, String] :group_id # - # @option params [String] :role_arn - # The ARN of the role you wish to associate with this group. + # @option params [required, String] :role_arn + # The ARN of the role you wish to associate with this group. The + # existence of the role is not validated. # # @return [Types::AssociateRoleToGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AssociateRoleToGroupResponse#associated_at #associated_at} => String # # @example Request syntax with placeholder values # # resp = client.associate_role_to_group({ # group_id: "__string", # required - # role_arn: "__string", + # role_arn: "__string", # required # }) # # @example Response structure # # resp.associated_at #=> String @@ -291,21 +292,21 @@ # role to access your Lambda functions and AWS IoT resources. This is # necessary for deployments to succeed. The role must have at least # minimum permissions in the policy # ''AWSGreengrassResourceAccessRolePolicy''. # - # @option params [String] :role_arn + # @option params [required, String] :role_arn # The ARN of the service role you wish to associate with your account. # # @return [Types::AssociateServiceRoleToAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AssociateServiceRoleToAccountResponse#associated_at #associated_at} => String # # @example Request syntax with placeholder values # # resp = client.associate_service_role_to_account({ - # role_arn: "__string", + # role_arn: "__string", # required # }) # # @example Response structure # # resp.associated_at #=> String @@ -330,10 +331,11 @@ # container for connectors. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateConnectorDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateConnectorDefinitionResponse#arn #arn} => String # * {Types::CreateConnectorDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -348,12 +350,12 @@ # resp = client.create_connector_definition({ # amzn_client_token: "__string", # initial_version: { # connectors: [ # { - # connector_arn: "__string", - # id: "__string", + # connector_arn: "__string", # required + # id: "__string", # required # parameters: { # "__string" => "__string", # }, # }, # ], @@ -404,12 +406,12 @@ # resp = client.create_connector_definition_version({ # amzn_client_token: "__string", # connector_definition_id: "__string", # required # connectors: [ # { - # connector_arn: "__string", - # id: "__string", + # connector_arn: "__string", # required + # id: "__string", # required # parameters: { # "__string" => "__string", # }, # }, # ], @@ -442,10 +444,11 @@ # Information about a core definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateCoreDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateCoreDefinitionResponse#arn #arn} => String # * {Types::CreateCoreDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -460,14 +463,14 @@ # resp = client.create_core_definition({ # amzn_client_token: "__string", # initial_version: { # cores: [ # { - # certificate_arn: "__string", - # id: "__string", + # certificate_arn: "__string", # required + # id: "__string", # required # sync_shadow: false, - # thing_arn: "__string", + # thing_arn: "__string", # required # }, # ], # }, # name: "__string", # tags: { @@ -515,14 +518,14 @@ # resp = client.create_core_definition_version({ # amzn_client_token: "__string", # core_definition_id: "__string", # required # cores: [ # { - # certificate_arn: "__string", - # id: "__string", + # certificate_arn: "__string", # required + # id: "__string", # required # sync_shadow: false, - # thing_arn: "__string", + # thing_arn: "__string", # required # }, # ], # }) # # @example Response structure @@ -549,11 +552,11 @@ # # @option params [String] :deployment_id # The ID of the deployment if you wish to redeploy a previous # deployment. # - # @option params [String] :deployment_type + # @option params [required, String] :deployment_type # The type of deployment. When used for ''CreateDeployment'', only # ''NewDeployment'' and ''Redeployment'' are valid. # # @option params [required, String] :group_id # @@ -568,11 +571,11 @@ # @example Request syntax with placeholder values # # resp = client.create_deployment({ # amzn_client_token: "__string", # deployment_id: "__string", - # deployment_type: "NewDeployment", # accepts NewDeployment, Redeployment, ResetDeployment, ForceResetDeployment + # deployment_type: "NewDeployment", # required, accepts NewDeployment, Redeployment, ResetDeployment, ForceResetDeployment # group_id: "__string", # required # group_version_id: "__string", # }) # # @example Response structure @@ -599,10 +602,11 @@ # Information about a device definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateDeviceDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDeviceDefinitionResponse#arn #arn} => String # * {Types::CreateDeviceDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -617,14 +621,14 @@ # resp = client.create_device_definition({ # amzn_client_token: "__string", # initial_version: { # devices: [ # { - # certificate_arn: "__string", - # id: "__string", + # certificate_arn: "__string", # required + # id: "__string", # required # sync_shadow: false, - # thing_arn: "__string", + # thing_arn: "__string", # required # }, # ], # }, # name: "__string", # tags: { @@ -672,14 +676,14 @@ # resp = client.create_device_definition_version({ # amzn_client_token: "__string", # device_definition_id: "__string", # required # devices: [ # { - # certificate_arn: "__string", - # id: "__string", + # certificate_arn: "__string", # required + # id: "__string", # required # sync_shadow: false, - # thing_arn: "__string", + # thing_arn: "__string", # required # }, # ], # }) # # @example Response structure @@ -710,10 +714,11 @@ # Information about a function definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateFunctionDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateFunctionDefinitionResponse#arn #arn} => String # * {Types::CreateFunctionDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -752,11 +757,11 @@ # }, # }, # resource_access_policies: [ # { # permission: "ro", # accepts ro, rw - # resource_id: "__string", + # resource_id: "__string", # required # }, # ], # variables: { # "__string" => "__string", # }, @@ -765,11 +770,11 @@ # executable: "__string", # memory_size: 1, # pinned: false, # timeout: 1, # }, - # id: "__string", + # id: "__string", # required # }, # ], # }, # name: "__string", # tags: { @@ -845,11 +850,11 @@ # }, # }, # resource_access_policies: [ # { # permission: "ro", # accepts ro, rw - # resource_id: "__string", + # resource_id: "__string", # required # }, # ], # variables: { # "__string" => "__string", # }, @@ -858,11 +863,11 @@ # executable: "__string", # memory_size: 1, # pinned: false, # timeout: 1, # }, - # id: "__string", + # id: "__string", # required # }, # ], # }) # # @example Response structure @@ -893,10 +898,11 @@ # Information about a group version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGroupResponse#arn #arn} => String # * {Types::CreateGroupResponse#creation_timestamp #creation_timestamp} => String @@ -1042,10 +1048,11 @@ # Information about a logger definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateLoggerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateLoggerDefinitionResponse#arn #arn} => String # * {Types::CreateLoggerDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -1060,15 +1067,15 @@ # resp = client.create_logger_definition({ # amzn_client_token: "__string", # initial_version: { # loggers: [ # { - # component: "GreengrassSystem", # accepts GreengrassSystem, Lambda - # id: "__string", - # level: "DEBUG", # accepts DEBUG, INFO, WARN, ERROR, FATAL + # component: "GreengrassSystem", # required, accepts GreengrassSystem, Lambda + # id: "__string", # required + # level: "DEBUG", # required, accepts DEBUG, INFO, WARN, ERROR, FATAL # space: 1, - # type: "FileSystem", # accepts FileSystem, AWSCloudWatch + # type: "FileSystem", # required, accepts FileSystem, AWSCloudWatch # }, # ], # }, # name: "__string", # tags: { @@ -1116,15 +1123,15 @@ # resp = client.create_logger_definition_version({ # amzn_client_token: "__string", # logger_definition_id: "__string", # required # loggers: [ # { - # component: "GreengrassSystem", # accepts GreengrassSystem, Lambda - # id: "__string", - # level: "DEBUG", # accepts DEBUG, INFO, WARN, ERROR, FATAL + # component: "GreengrassSystem", # required, accepts GreengrassSystem, Lambda + # id: "__string", # required + # level: "DEBUG", # required, accepts DEBUG, INFO, WARN, ERROR, FATAL # space: 1, - # type: "FileSystem", # accepts FileSystem, AWSCloudWatch + # type: "FileSystem", # required, accepts FileSystem, AWSCloudWatch # }, # ], # }) # # @example Response structure @@ -1154,10 +1161,11 @@ # Information about a resource definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateResourceDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateResourceDefinitionResponse#arn #arn} => String # * {Types::CreateResourceDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -1172,13 +1180,13 @@ # resp = client.create_resource_definition({ # amzn_client_token: "__string", # initial_version: { # resources: [ # { - # id: "__string", - # name: "__string", - # resource_data_container: { + # id: "__string", # required + # name: "__string", # required + # resource_data_container: { # required # local_device_resource_data: { # group_owner_setting: { # auto_add_group_owner: false, # group_owner: "__string", # }, @@ -1254,13 +1262,13 @@ # resp = client.create_resource_definition_version({ # amzn_client_token: "__string", # resource_definition_id: "__string", # required # resources: [ # { - # id: "__string", - # name: "__string", - # resource_data_container: { + # id: "__string", # required + # name: "__string", # required + # resource_data_container: { # required # local_device_resource_data: { # group_owner_setting: { # auto_add_group_owner: false, # group_owner: "__string", # }, @@ -1313,29 +1321,29 @@ # provides additional commands to manage a Greengrass core software # update job. # # @option params [String] :amzn_client_token # - # @option params [String] :s3_url_signer_role + # @option params [required, String] :s3_url_signer_role # The IAM Role that Greengrass will use to create pre-signed URLs # pointing towards the update artifact. # - # @option params [String] :software_to_update + # @option params [required, String] :software_to_update # The piece of software on the Greengrass core that will be updated. # # @option params [String] :update_agent_log_level # The minimum level of log statements that should be logged by the OTA # Agent during an update. # - # @option params [Array<String>] :update_targets + # @option params [required, Array<String>] :update_targets # The ARNs of the targets (IoT things or IoT thing groups) that this # update will be applied to. # - # @option params [String] :update_targets_architecture + # @option params [required, String] :update_targets_architecture # The architecture of the cores which are the targets of an update. # - # @option params [String] :update_targets_operating_system + # @option params [required, String] :update_targets_operating_system # The operating system of the cores which are the targets of an update. # # @return [Types::CreateSoftwareUpdateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateSoftwareUpdateJobResponse#iot_job_arn #iot_job_arn} => String @@ -1343,16 +1351,16 @@ # # @example Request syntax with placeholder values # # resp = client.create_software_update_job({ # amzn_client_token: "__string", - # s3_url_signer_role: "S3UrlSignerRole", - # software_to_update: "core", # accepts core, ota_agent + # s3_url_signer_role: "S3UrlSignerRole", # required + # software_to_update: "core", # required, accepts core, ota_agent # update_agent_log_level: "NONE", # accepts NONE, TRACE, DEBUG, VERBOSE, INFO, WARN, ERROR, FATAL - # update_targets: ["__string"], - # update_targets_architecture: "armv7l", # accepts armv7l, x86_64, aarch64 - # update_targets_operating_system: "ubuntu", # accepts ubuntu, raspbian, amazon_linux + # update_targets: ["__string"], # required + # update_targets_architecture: "armv7l", # required, accepts armv7l, x86_64, aarch64, openwrt + # update_targets_operating_system: "ubuntu", # required, accepts ubuntu, raspbian, amazon_linux # }) # # @example Response structure # # resp.iot_job_arn #=> String @@ -1377,10 +1385,11 @@ # Information about a subscription definition version. # # @option params [String] :name # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::CreateSubscriptionDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateSubscriptionDefinitionResponse#arn #arn} => String # * {Types::CreateSubscriptionDefinitionResponse#creation_timestamp #creation_timestamp} => String @@ -1395,14 +1404,14 @@ # resp = client.create_subscription_definition({ # amzn_client_token: "__string", # initial_version: { # subscriptions: [ # { - # id: "__string", - # source: "__string", - # subject: "__string", - # target: "__string", + # id: "__string", # required + # source: "__string", # required + # subject: "__string", # required + # target: "__string", # required # }, # ], # }, # name: "__string", # tags: { @@ -1450,14 +1459,14 @@ # resp = client.create_subscription_definition_version({ # amzn_client_token: "__string", # subscription_definition_id: "__string", # required # subscriptions: [ # { - # id: "__string", - # source: "__string", - # subject: "__string", - # target: "__string", + # id: "__string", # required + # source: "__string", # required + # subject: "__string", # required + # target: "__string", # required # }, # ], # }) # # @example Response structure @@ -1474,38 +1483,10 @@ def create_subscription_definition_version(params = {}, options = {}) req = build_request(:create_subscription_definition_version, params) req.send_request(options) end - # Add resource tags to a Greengrass Resource. Valid resources are Group, - # Connector, Core, Device, Function, Logger, Subscription, and Resource - # Defintions, and also BulkDeploymentIds. - # - # @option params [required, String] :resource_arn - # - # @option params [required, Hash<String,String>] :tags - # - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. - # - # @example Request syntax with placeholder values - # - # resp = client.tag_resource({ - # resource_arn: "__string", # required - # tags: { # required - # "__string" => "__string", - # }, - # }) - # - # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/TagResource AWS API Documentation - # - # @overload tag_resource(params = {}) - # @param [Hash] params ({}) - def tag_resource(params = {}, options = {}) - req = build_request(:tag_resource, params) - req.send_request(options) - end - # Deletes a connector definition. # # @option params [required, String] :connector_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -1670,34 +1651,10 @@ def delete_subscription_definition(params = {}, options = {}) req = build_request(:delete_subscription_definition, params) req.send_request(options) end - # Remove resource tags from a Greengrass Resource. - # - # @option params [required, String] :resource_arn - # - # @option params [required, Array<String>] :tag_keys - # - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. - # - # @example Request syntax with placeholder values - # - # resp = client.untag_resource({ - # resource_arn: "__string", # required - # tag_keys: ["__string"], # required - # }) - # - # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/UntagResource AWS API Documentation - # - # @overload untag_resource(params = {}) - # @param [Hash] params ({}) - def untag_resource(params = {}, options = {}) - req = build_request(:untag_resource, params) - req.send_request(options) - end - # Disassociates the role from a group. # # @option params [required, String] :group_id # # @return [Types::DisassociateRoleFromGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -3573,39 +3530,40 @@ # request. These requests are idempotent with respect to the token and # the request parameters. # # @option params [String] :amzn_client_token # - # @option params [String] :execution_role_arn + # @option params [required, String] :execution_role_arn # The ARN of the execution role to associate with the bulk deployment # operation. This IAM role must allow the # ''greengrass:CreateDeployment'' action for all group versions that # are listed in the input file. This IAM role must have access to the S3 # bucket containing the input file. # - # @option params [String] :input_file_uri + # @option params [required, String] :input_file_uri # The URI of the input file contained in the S3 bucket. The execution # role must have ''getObject'' permissions on this bucket to access # the input file. The input file is a JSON-serialized, line delimited # file with UTF-8 encoding that provides a list of group and version IDs # and the deployment type. This file must be less than 100 MB. # Currently, AWS IoT Greengrass supports only ''NewDeployment'' # deployment types. # # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. # # @return [Types::StartBulkDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartBulkDeploymentResponse#bulk_deployment_arn #bulk_deployment_arn} => String # * {Types::StartBulkDeploymentResponse#bulk_deployment_id #bulk_deployment_id} => String # # @example Request syntax with placeholder values # # resp = client.start_bulk_deployment({ # amzn_client_token: "__string", - # execution_role_arn: "__string", - # input_file_uri: "__string", + # execution_role_arn: "__string", # required + # input_file_uri: "__string", # required # tags: { # "__string" => "__string", # }, # }) # @@ -3646,10 +3604,63 @@ def stop_bulk_deployment(params = {}, options = {}) req = build_request(:stop_bulk_deployment, params) req.send_request(options) end + # Add resource tags to a Greengrass Resource. Valid resources are Group, + # Connector, Core, Device, Function, Logger, Subscription, and Resource + # Defintions, and also BulkDeploymentIds. + # + # @option params [required, String] :resource_arn + # + # @option params [Hash<String,String>] :tags + # The key-value pair for the resource tag. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "__string", # required + # tags: { + # "__string" => "__string", + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + + # Remove resource tags from a Greengrass Resource. + # + # @option params [required, String] :resource_arn + # + # @option params [required, Array<String>] :tag_keys + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "__string", # required + # tag_keys: ["__string"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + end + # Updates the connectivity information for the core. Any devices that # belong to the group which has this core will receive this information # in order to find the location of the core and connect to it. # # @option params [Array<Types::ConnectivityInfo>] :connectivity_info @@ -3929,10 +3940,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-greengrass' - context[:gem_version] = '1.23.0' + context[:gem_version] = '1.24.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated