lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.2.0 vs lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.3.0

- old
+ new

@@ -143,19 +143,19 @@ super end # @!group API Operations - # Associates a role with a group. The role will be used by the AWS - # Greengrass core in order to access AWS cloud services. The role's - # permissions will allow Greengrass core Lambda functions to perform - # actions against the cloud. + # Associates a role with a group. Your AWS Greengrass core will use the + # role 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 - # Role arn you wish to associate with this group. + # The ARN of the role you wish to associate with this group. # # @return [Types::AssociateRoleToGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AssociateRoleToGroupResponse#associated_at #associated_at} => String # @@ -177,17 +177,18 @@ def associate_role_to_group(params = {}, options = {}) req = build_request(:associate_role_to_group, params) req.send_request(options) end - # Associates a role which is used by AWS Greengrass. AWS Greengrass uses - # the role to access your Lambda functions and AWS IoT resources. This - # is necessary for deployments to succeed. It needs to have minimum - # permissions in policy ``AWSGreengrassResourceAccessRolePolicy`` + # Associates a role with your account. AWS Greengrass will use the 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 - # Role arn you wish to associate with this account. + # 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 # @@ -208,19 +209,19 @@ def associate_service_role_to_account(params = {}, options = {}) req = build_request(:associate_service_role_to_account, params) req.send_request(options) end - # Creates a core definition. You may optionally provide the initial - # version of the core definition or use - # ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass - # Groups must each contain exactly 1 AWS Greengrass Core. + # Creates a core definition. You may provide the initial version of the + # core definition now or use ''CreateCoreDefinitionVersion'' at a + # later time. AWS Greengrass groups must each contain exactly one AWS + # Greengrass core. # # @option params [String] :amzn_client_token # # @option params [Types::CoreDefinitionVersion] :initial_version - # Information on core definition version + # Information about a core definition version. # # @option params [String] :name # # @return [Types::CreateCoreDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -267,11 +268,12 @@ req = build_request(:create_core_definition, params) req.send_request(options) end # Creates a version of a core definition that has already been defined. - # AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core. + # AWS Greengrass groups must each contain exactly one AWS Greengrass + # core. # # @option params [String] :amzn_client_token # # @option params [required, String] :core_definition_id # @@ -318,20 +320,21 @@ # Creates a deployment. # # @option params [String] :amzn_client_token # # @option params [String] :deployment_id - # Id of the deployment if you wish to redeploy a previous deployment. + # The ID of the deployment if you wish to redeploy a previous + # deployment. # # @option params [String] :deployment_type - # Type of deployment. When used in CreateDeployment, only NewDeployment - # and Redeployment are valid. + # The type of deployment. When used in ''CreateDeployment'', only + # ''NewDeployment'' and ''Redeployment'' are valid. # # @option params [required, String] :group_id # # @option params [String] :group_version_id - # Group Version you wish to deploy. + # The ID of the group version to be deployed. # # @return [Types::CreateDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDeploymentResponse#deployment_arn #deployment_arn} => String # * {Types::CreateDeploymentResponse#deployment_id #deployment_id} => String @@ -358,18 +361,18 @@ def create_deployment(params = {}, options = {}) req = build_request(:create_deployment, params) req.send_request(options) end - # Creates a device definition. You may optinally provide the initial - # version of the device definition or use - # ``CreateDeviceDefinitionVersion`` at a later time. + # Creates a device definition. You may provide the initial version of + # the device definition now or use ''CreateDeviceDefinitionVersion'' + # at a later time. # # @option params [String] :amzn_client_token # # @option params [Types::DeviceDefinitionVersion] :initial_version - # Information on device definition version + # Information about a device definition version. # # @option params [String] :name # # @return [Types::CreateDeviceDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -466,16 +469,16 @@ # Creates a Lambda function definition which contains a list of Lambda # functions and their configurations to be used in a group. You can # create an initial version of the definition by providing a list of # Lambda functions and their configurations now, or use - # ``CreateFunctionDefinitionVersion`` later. + # ''CreateFunctionDefinitionVersion'' later. # # @option params [String] :amzn_client_token # # @option params [Types::FunctionDefinitionVersion] :initial_version - # Information on the function definition version + # Information about a function definition version. # # @option params [String] :name # # @return [Types::CreateFunctionDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -494,10 +497,11 @@ # initial_version: { # functions: [ # { # function_arn: "__string", # function_configuration: { + # encoding_type: "binary", # accepts binary, json # environment: { # access_sysfs: false, # resource_access_policies: [ # { # permission: "ro", # accepts ro, rw @@ -538,12 +542,12 @@ def create_function_definition(params = {}, options = {}) req = build_request(:create_function_definition, params) req.send_request(options) end - # Create a version of a Lambda function definition that has already been - # defined. + # Creates a version of a Lambda function definition that has already + # been defined. # # @option params [String] :amzn_client_token # # @option params [required, String] :function_definition_id # @@ -563,10 +567,11 @@ # function_definition_id: "__string", # required # functions: [ # { # function_arn: "__string", # function_configuration: { + # encoding_type: "binary", # accepts binary, json # environment: { # access_sysfs: false, # resource_access_policies: [ # { # permission: "ro", # accepts ro, rw @@ -602,17 +607,17 @@ def create_function_definition_version(params = {}, options = {}) req = build_request(:create_function_definition_version, params) req.send_request(options) end - # Creates a group. You may optionally provide the initial version of the - # group or use ''CreateGroupVersion'' at a later time. + # Creates a group. You may provide the initial version of the group or + # use ''CreateGroupVersion'' at a later time. # # @option params [String] :amzn_client_token # # @option params [Types::GroupVersion] :initial_version - # Information on group version + # Information about a group version. # # @option params [String] :name # # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -741,18 +746,18 @@ def create_group_version(params = {}, options = {}) req = build_request(:create_group_version, params) req.send_request(options) end - # Creates a logger definition. You may optionally provide the initial - # version of the logger definition or use - # ``CreateLoggerDefinitionVersion`` at a later time. + # Creates a logger definition. You may provide the initial version of + # the logger definition now or use ''CreateLoggerDefinitionVersion'' + # at a later time. # # @option params [String] :amzn_client_token # # @option params [Types::LoggerDefinitionVersion] :initial_version - # Information on logger definition version + # Information about a logger definition version. # # @option params [String] :name # # @return [Types::CreateLoggerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -850,16 +855,16 @@ end # Creates a resource definition which contains a list of resources to be # used in a group. You can create an initial version of the definition # by providing a list of resources now, or use - # ``CreateResourceDefinitionVersion`` later. + # ''CreateResourceDefinitionVersion'' later. # # @option params [String] :amzn_client_token # # @option params [Types::ResourceDefinitionVersion] :initial_version - # Information on resource definition version + # Information about a resource definition version. # # @option params [String] :name # # @return [Types::CreateResourceDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -894,10 +899,18 @@ # auto_add_group_owner: false, # group_owner: "__string", # }, # source_path: "__string", # }, + # s3_machine_learning_model_resource_data: { + # destination_path: "__string", + # s3_uri: "__string", + # }, + # sage_maker_machine_learning_model_resource_data: { + # destination_path: "__string", + # sage_maker_job_arn: "__string", + # }, # }, # }, # ], # }, # name: "__string", @@ -920,11 +933,11 @@ def create_resource_definition(params = {}, options = {}) req = build_request(:create_resource_definition, params) req.send_request(options) end - # Create a version of a resource definition that has already been + # Creates a version of a resource definition that has already been # defined. # # @option params [String] :amzn_client_token # # @option params [required, String] :resource_definition_id @@ -961,10 +974,18 @@ # auto_add_group_owner: false, # group_owner: "__string", # }, # source_path: "__string", # }, + # s3_machine_learning_model_resource_data: { + # destination_path: "__string", + # s3_uri: "__string", + # }, + # sage_maker_machine_learning_model_resource_data: { + # destination_path: "__string", + # sage_maker_job_arn: "__string", + # }, # }, # }, # ], # }) # @@ -982,34 +1003,38 @@ def create_resource_definition_version(params = {}, options = {}) req = build_request(:create_resource_definition_version, params) req.send_request(options) end - # Creates an Iot Job that will trigger your Greengrass Cores to update - # the software they are running. + # Creates a software update for a core or group of cores (specified as + # an IoT thing group.) Use this to update the OTA Agent as well as the + # Greengrass core software. It makes use of the IoT Jobs feature which + # provides additional commands to manage a Greengrass core software + # update job. # # @option params [String] :amzn_client_token # # @option params [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 - # The piece of software on the Greengrass Core that will be updated. + # 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 - # The target arns that this update will be applied to. + # The ARNs of the targets (IoT things or IoT thing groups) that this + # update will be applied to. # # @option params [String] :update_targets_architecture - # The architecture of the Cores in the targets of an update + # The architecture of the cores which are the targets of an update. # # @option params [String] :update_targets_operating_system - # The operating system of the Cores in the targets of an update + # 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 # * {Types::CreateSoftwareUpdateJobResponse#iot_job_id #iot_job_id} => String @@ -1038,18 +1063,18 @@ def create_software_update_job(params = {}, options = {}) req = build_request(:create_software_update_job, params) req.send_request(options) end - # Creates a subscription definition. You may optionally provide the - # initial version of the subscription definition or use - # ``CreateSubscriptionDefinitionVersion`` at a later time. + # Creates a subscription definition. You may provide the initial version + # of the subscription definition now or use + # ''CreateSubscriptionDefinitionVersion'' at a later time. # # @option params [String] :amzn_client_token # # @option params [Types::SubscriptionDefinitionVersion] :initial_version - # Information on subscription definition version + # Information about a subscription definition version. # # @option params [String] :name # # @return [Types::CreateSubscriptionDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1142,12 +1167,11 @@ def create_subscription_definition_version(params = {}, options = {}) req = build_request(:create_subscription_definition_version, params) req.send_request(options) end - # Deletes a core definition. The core definition must not have been used - # in a deployment. + # Deletes a core definition. # # @option params [required, String] :core_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1164,12 +1188,11 @@ def delete_core_definition(params = {}, options = {}) req = build_request(:delete_core_definition, params) req.send_request(options) end - # Deletes a device definition. The device definition must not have been - # used in a deployment. + # Deletes a device definition. # # @option params [required, String] :device_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1186,12 +1209,11 @@ def delete_device_definition(params = {}, options = {}) req = build_request(:delete_device_definition, params) req.send_request(options) end - # Deletes a Lambda function definition. The Lambda function definition - # must not have been used in a deployment. + # Deletes a Lambda function definition. # # @option params [required, String] :function_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1208,11 +1230,11 @@ def delete_function_definition(params = {}, options = {}) req = build_request(:delete_function_definition, params) req.send_request(options) end - # Deletes a group. The group must not have been used in deployment. + # Deletes a group. # # @option params [required, String] :group_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1229,12 +1251,11 @@ def delete_group(params = {}, options = {}) req = build_request(:delete_group, params) req.send_request(options) end - # Deletes a logger definition. The logger definition must not have been - # used in a deployment. + # Deletes a logger definition. # # @option params [required, String] :logger_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1272,12 +1293,11 @@ def delete_resource_definition(params = {}, options = {}) req = build_request(:delete_resource_definition, params) req.send_request(options) end - # Deletes a subscription definition. The subscription definition must - # not have been used in a deployment. + # Deletes a subscription definition. # # @option params [required, String] :subscription_definition_id # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1321,11 +1341,11 @@ def disassociate_role_from_group(params = {}, options = {}) req = build_request(:disassociate_role_from_group, params) req.send_request(options) end - # Disassociates the service role from the account. Without a service + # Disassociates the service role from your account. Without a service # role, deployments will not work. # # @return [Types::DisassociateServiceRoleFromAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DisassociateServiceRoleFromAccountResponse#disassociated_at #disassociated_at} => String @@ -1605,12 +1625,12 @@ def get_device_definition_version(params = {}, options = {}) req = build_request(:get_device_definition_version, params) req.send_request(options) end - # Retrieves information about a Lambda function definition, such as its - # creation time and latest version. + # Retrieves information about a Lambda function definition, including + # its creation time and latest version. # # @option params [required, String] :function_definition_id # # @return [Types::GetFunctionDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1645,12 +1665,12 @@ def get_function_definition(params = {}, options = {}) req = build_request(:get_function_definition, params) req.send_request(options) end - # Retrieves information about a Lambda function definition version, such - # as which Lambda functions are included in the version and their + # Retrieves information about a Lambda function definition version, + # including which Lambda functions are included in the version and their # configurations. # # @option params [required, String] :function_definition_id # # @option params [required, String] :function_definition_version_id @@ -1674,10 +1694,11 @@ # # resp.arn #=> String # resp.creation_timestamp #=> String # resp.definition.functions #=> Array # resp.definition.functions[0].function_arn #=> String + # resp.definition.functions[0].function_configuration.encoding_type #=> String, one of "binary", "json" # resp.definition.functions[0].function_configuration.environment.access_sysfs #=> Boolean # resp.definition.functions[0].function_configuration.environment.resource_access_policies #=> Array # resp.definition.functions[0].function_configuration.environment.resource_access_policies[0].permission #=> String, one of "ro", "rw" # resp.definition.functions[0].function_configuration.environment.resource_access_policies[0].resource_id #=> String # resp.definition.functions[0].function_configuration.environment.variables #=> Hash @@ -1928,11 +1949,11 @@ def get_logger_definition_version(params = {}, options = {}) req = build_request(:get_logger_definition_version, params) req.send_request(options) end - # Retrieves information about a resource definition, such as its + # Retrieves information about a resource definition, including its # creation time and latest version. # # @option params [required, String] :resource_definition_id # # @return [Types::GetResourceDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1968,11 +1989,11 @@ def get_resource_definition(params = {}, options = {}) req = build_request(:get_resource_definition, params) req.send_request(options) end - # Retrieves information about a resource definition version, such as + # Retrieves information about a resource definition version, including # which resources are included in the version. # # @option params [required, String] :resource_definition_id # # @option params [required, String] :resource_definition_version_id @@ -2004,10 +2025,14 @@ # resp.definition.resources[0].resource_data_container.local_device_resource_data.source_path #=> String # resp.definition.resources[0].resource_data_container.local_volume_resource_data.destination_path #=> String # resp.definition.resources[0].resource_data_container.local_volume_resource_data.group_owner_setting.auto_add_group_owner #=> Boolean # resp.definition.resources[0].resource_data_container.local_volume_resource_data.group_owner_setting.group_owner #=> String # resp.definition.resources[0].resource_data_container.local_volume_resource_data.source_path #=> String + # resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.destination_path #=> String + # resp.definition.resources[0].resource_data_container.s3_machine_learning_model_resource_data.s3_uri #=> String + # resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.destination_path #=> String + # resp.definition.resources[0].resource_data_container.sage_maker_machine_learning_model_resource_data.sage_maker_job_arn #=> String # resp.id #=> String # resp.version #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetResourceDefinitionVersion AWS API Documentation # @@ -2016,11 +2041,11 @@ def get_resource_definition_version(params = {}, options = {}) req = build_request(:get_resource_definition_version, params) req.send_request(options) end - # Retrieves the service role that is attached to the account. + # Retrieves the service role that is attached to your account. # # @return [Types::GetServiceRoleForAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetServiceRoleForAccountResponse#associated_at #associated_at} => String # * {Types::GetServiceRoleForAccountResponse#role_arn #role_arn} => String @@ -2118,11 +2143,11 @@ def get_subscription_definition_version(params = {}, options = {}) req = build_request(:get_subscription_definition_version, params) req.send_request(options) end - # Lists versions of a core definition. + # Lists the versions of a core definition. # # @option params [required, String] :core_definition_id # # @option params [String] :max_results # @@ -2421,11 +2446,11 @@ def list_group_certificate_authorities(params = {}, options = {}) req = build_request(:list_group_certificate_authorities, params) req.send_request(options) end - # List the versions of a group. + # Lists the versions of a group. # # @option params [required, String] :group_id # # @option params [String] :max_results # @@ -2738,11 +2763,11 @@ # Resets a group's deployments. # # @option params [String] :amzn_client_token # # @option params [Boolean] :force - # When set to true, perform a best-effort only core reset. + # If true, performs a best-effort only core reset. # # @option params [required, String] :group_id # # @return [Types::ResetDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2774,11 +2799,11 @@ # 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 - # Connectivity info list + # A list of connectivity info. # # @option params [required, String] :thing_name # # @return [Types::UpdateConnectivityInfoResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2907,14 +2932,15 @@ def update_group(params = {}, options = {}) req = build_request(:update_group, params) req.send_request(options) end - # Updates the Cert expiry time for a group. + # Updates the Certificate expiry time for a group. # # @option params [String] :certificate_expiry_in_milliseconds - # Amount of time when the certificate expires in milliseconds. + # The amount of time remaining before the certificate expires, in + # milliseconds. # # @option params [required, String] :group_id # # @return [Types::UpdateGroupCertificateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3027,10 +3053,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-greengrass' - context[:gem_version] = '1.2.0' + context[:gem_version] = '1.3.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated