lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.9.0 vs lib/aws-sdk-greengrass/client.rb in aws-sdk-greengrass-1.10.0

- old
+ new

@@ -348,11 +348,13 @@ def create_core_definition_version(params = {}, options = {}) req = build_request(:create_core_definition_version, params) req.send_request(options) end - # Creates a deployment. + # Creates a deployment. ''CreateDeployment'' requests are idempotent + # with respect to the ''X-Amzn-Client-Token'' token and the request + # parameters. # # @option params [String] :amzn_client_token # # @option params [String] :deployment_id # The ID of the deployment if you wish to redeploy a previous @@ -1423,10 +1425,49 @@ def get_associated_role(params = {}, options = {}) req = build_request(:get_associated_role, params) req.send_request(options) end + # Returns the status of a bulk deployment. + # + # @option params [required, String] :bulk_deployment_id + # + # @return [Types::GetBulkDeploymentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetBulkDeploymentStatusResponse#bulk_deployment_metrics #bulk_deployment_metrics} => Types::BulkDeploymentMetrics + # * {Types::GetBulkDeploymentStatusResponse#bulk_deployment_status #bulk_deployment_status} => String + # * {Types::GetBulkDeploymentStatusResponse#created_at #created_at} => String + # * {Types::GetBulkDeploymentStatusResponse#error_details #error_details} => Array&lt;Types::ErrorDetail&gt; + # * {Types::GetBulkDeploymentStatusResponse#error_message #error_message} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_bulk_deployment_status({ + # bulk_deployment_id: "__string", # required + # }) + # + # @example Response structure + # + # resp.bulk_deployment_metrics.invalid_input_records #=> Integer + # resp.bulk_deployment_metrics.records_processed #=> Integer + # resp.bulk_deployment_metrics.retry_attempts #=> Integer + # resp.bulk_deployment_status #=> String, one of "Initializing", "Running", "Completed", "Stopping", "Stopped", "Failed" + # resp.created_at #=> String + # resp.error_details #=> Array + # resp.error_details[0].detailed_error_code #=> String + # resp.error_details[0].detailed_error_message #=> String + # resp.error_message #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetBulkDeploymentStatus AWS API Documentation + # + # @overload get_bulk_deployment_status(params = {}) + # @param [Hash] params ({}) + def get_bulk_deployment_status(params = {}, options = {}) + req = build_request(:get_bulk_deployment_status, params) + req.send_request(options) + end + # Retrieves the connectivity information for a core. # # @option params [required, String] :thing_name # # @return [Types::GetConnectivityInfoResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1507,10 +1548,11 @@ # # * {Types::GetCoreDefinitionVersionResponse#arn #arn} => String # * {Types::GetCoreDefinitionVersionResponse#creation_timestamp #creation_timestamp} => String # * {Types::GetCoreDefinitionVersionResponse#definition #definition} => Types::CoreDefinitionVersion # * {Types::GetCoreDefinitionVersionResponse#id #id} => String + # * {Types::GetCoreDefinitionVersionResponse#next_token #next_token} => String # * {Types::GetCoreDefinitionVersionResponse#version #version} => String # # @example Request syntax with placeholder values # # resp = client.get_core_definition_version({ @@ -1526,10 +1568,11 @@ # resp.definition.cores[0].certificate_arn #=> String # resp.definition.cores[0].id #=> String # resp.definition.cores[0].sync_shadow #=> Boolean # resp.definition.cores[0].thing_arn #=> String # resp.id #=> String + # resp.next_token #=> String # resp.version #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetCoreDefinitionVersion AWS API Documentation # # @overload get_core_definition_version(params = {}) @@ -1622,23 +1665,27 @@ # # @option params [required, String] :device_definition_id # # @option params [required, String] :device_definition_version_id # + # @option params [String] :next_token + # # @return [Types::GetDeviceDefinitionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDeviceDefinitionVersionResponse#arn #arn} => String # * {Types::GetDeviceDefinitionVersionResponse#creation_timestamp #creation_timestamp} => String # * {Types::GetDeviceDefinitionVersionResponse#definition #definition} => Types::DeviceDefinitionVersion # * {Types::GetDeviceDefinitionVersionResponse#id #id} => String + # * {Types::GetDeviceDefinitionVersionResponse#next_token #next_token} => String # * {Types::GetDeviceDefinitionVersionResponse#version #version} => String # # @example Request syntax with placeholder values # # resp = client.get_device_definition_version({ # device_definition_id: "__string", # required # device_definition_version_id: "__string", # required + # next_token: "__string", # }) # # @example Response structure # # resp.arn #=> String @@ -1647,10 +1694,11 @@ # resp.definition.devices[0].certificate_arn #=> String # resp.definition.devices[0].id #=> String # resp.definition.devices[0].sync_shadow #=> Boolean # resp.definition.devices[0].thing_arn #=> String # resp.id #=> String + # resp.next_token #=> String # resp.version #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetDeviceDefinitionVersion AWS API Documentation # # @overload get_device_definition_version(params = {}) @@ -1706,23 +1754,27 @@ # # @option params [required, String] :function_definition_id # # @option params [required, String] :function_definition_version_id # + # @option params [String] :next_token + # # @return [Types::GetFunctionDefinitionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetFunctionDefinitionVersionResponse#arn #arn} => String # * {Types::GetFunctionDefinitionVersionResponse#creation_timestamp #creation_timestamp} => String # * {Types::GetFunctionDefinitionVersionResponse#definition #definition} => Types::FunctionDefinitionVersion # * {Types::GetFunctionDefinitionVersionResponse#id #id} => String + # * {Types::GetFunctionDefinitionVersionResponse#next_token #next_token} => String # * {Types::GetFunctionDefinitionVersionResponse#version #version} => String # # @example Request syntax with placeholder values # # resp = client.get_function_definition_version({ # function_definition_id: "__string", # required # function_definition_version_id: "__string", # required + # next_token: "__string", # }) # # @example Response structure # # resp.arn #=> String @@ -1741,10 +1793,11 @@ # resp.definition.functions[0].function_configuration.memory_size #=> Integer # resp.definition.functions[0].function_configuration.pinned #=> Boolean # resp.definition.functions[0].function_configuration.timeout #=> Integer # resp.definition.functions[0].id #=> String # resp.id #=> String + # resp.next_token #=> String # resp.version #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetFunctionDefinitionVersion AWS API Documentation # # @overload get_function_definition_version(params = {}) @@ -1945,10 +1998,12 @@ # # @option params [required, String] :logger_definition_id # # @option params [required, String] :logger_definition_version_id # + # @option params [String] :next_token + # # @return [Types::GetLoggerDefinitionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetLoggerDefinitionVersionResponse#arn #arn} => String # * {Types::GetLoggerDefinitionVersionResponse#creation_timestamp #creation_timestamp} => String # * {Types::GetLoggerDefinitionVersionResponse#definition #definition} => Types::LoggerDefinitionVersion @@ -1958,10 +2013,11 @@ # @example Request syntax with placeholder values # # resp = client.get_logger_definition_version({ # logger_definition_id: "__string", # required # logger_definition_version_id: "__string", # required + # next_token: "__string", # }) # # @example Response structure # # resp.arn #=> String @@ -2136,25 +2192,29 @@ req.send_request(options) end # Retrieves information about a subscription definition version. # + # @option params [String] :next_token + # # @option params [required, String] :subscription_definition_id # # @option params [required, String] :subscription_definition_version_id # # @return [Types::GetSubscriptionDefinitionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetSubscriptionDefinitionVersionResponse#arn #arn} => String # * {Types::GetSubscriptionDefinitionVersionResponse#creation_timestamp #creation_timestamp} => String # * {Types::GetSubscriptionDefinitionVersionResponse#definition #definition} => Types::SubscriptionDefinitionVersion # * {Types::GetSubscriptionDefinitionVersionResponse#id #id} => String + # * {Types::GetSubscriptionDefinitionVersionResponse#next_token #next_token} => String # * {Types::GetSubscriptionDefinitionVersionResponse#version #version} => String # # @example Request syntax with placeholder values # # resp = client.get_subscription_definition_version({ + # next_token: "__string", # subscription_definition_id: "__string", # required # subscription_definition_version_id: "__string", # required # }) # # @example Response structure @@ -2165,10 +2225,11 @@ # resp.definition.subscriptions[0].id #=> String # resp.definition.subscriptions[0].source #=> String # resp.definition.subscriptions[0].subject #=> String # resp.definition.subscriptions[0].target #=> String # resp.id #=> String + # resp.next_token #=> String # resp.version #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/GetSubscriptionDefinitionVersion AWS API Documentation # # @overload get_subscription_definition_version(params = {}) @@ -2176,10 +2237,91 @@ def get_subscription_definition_version(params = {}, options = {}) req = build_request(:get_subscription_definition_version, params) req.send_request(options) end + # Gets a paginated list of the deployments that have been started in a + # bulk deployment operation, and their current deployment status. + # + # @option params [required, String] :bulk_deployment_id + # + # @option params [String] :max_results + # + # @option params [String] :next_token + # + # @return [Types::ListBulkDeploymentDetailedReportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListBulkDeploymentDetailedReportsResponse#deployments #deployments} => Array&lt;Types::BulkDeploymentResult&gt; + # * {Types::ListBulkDeploymentDetailedReportsResponse#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.list_bulk_deployment_detailed_reports({ + # bulk_deployment_id: "__string", # required + # max_results: "__string", + # next_token: "__string", + # }) + # + # @example Response structure + # + # resp.deployments #=> Array + # resp.deployments[0].created_at #=> String + # resp.deployments[0].deployment_arn #=> String + # resp.deployments[0].deployment_id #=> String + # resp.deployments[0].deployment_status #=> String + # resp.deployments[0].deployment_type #=> String, one of "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment" + # resp.deployments[0].error_details #=> Array + # resp.deployments[0].error_details[0].detailed_error_code #=> String + # resp.deployments[0].error_details[0].detailed_error_message #=> String + # resp.deployments[0].error_message #=> String + # resp.deployments[0].group_arn #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/ListBulkDeploymentDetailedReports AWS API Documentation + # + # @overload list_bulk_deployment_detailed_reports(params = {}) + # @param [Hash] params ({}) + def list_bulk_deployment_detailed_reports(params = {}, options = {}) + req = build_request(:list_bulk_deployment_detailed_reports, params) + req.send_request(options) + end + + # Returns a list of bulk deployments. + # + # @option params [String] :max_results + # + # @option params [String] :next_token + # + # @return [Types::ListBulkDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListBulkDeploymentsResponse#bulk_deployments #bulk_deployments} => Array&lt;Types::BulkDeployment&gt; + # * {Types::ListBulkDeploymentsResponse#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.list_bulk_deployments({ + # max_results: "__string", + # next_token: "__string", + # }) + # + # @example Response structure + # + # resp.bulk_deployments #=> Array + # resp.bulk_deployments[0].bulk_deployment_arn #=> String + # resp.bulk_deployments[0].bulk_deployment_id #=> String + # resp.bulk_deployments[0].created_at #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/ListBulkDeployments AWS API Documentation + # + # @overload list_bulk_deployments(params = {}) + # @param [Hash] params ({}) + def list_bulk_deployments(params = {}, options = {}) + req = build_request(:list_bulk_deployments, params) + req.send_request(options) + end + # Lists the versions of a core definition. # # @option params [required, String] :core_definition_id # # @option params [String] :max_results @@ -2827,10 +2969,87 @@ def reset_deployments(params = {}, options = {}) req = build_request(:reset_deployments, params) req.send_request(options) end + # Deploys multiple groups in one operation. This action starts the bulk + # deployment of a specified set of group versions. Each group version + # deployment will be triggered with an adaptive rate that has a fixed + # upper limit. We recommend that you include an + # ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' + # 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 + # 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 + # 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 100MB. Currently, + # Greengrass; supports only ''NewDeployment'' deployment types. + # + # @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", + # }) + # + # @example Response structure + # + # resp.bulk_deployment_arn #=> String + # resp.bulk_deployment_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/StartBulkDeployment AWS API Documentation + # + # @overload start_bulk_deployment(params = {}) + # @param [Hash] params ({}) + def start_bulk_deployment(params = {}, options = {}) + req = build_request(:start_bulk_deployment, params) + req.send_request(options) + end + + # Stops the execution of a bulk deployment. This action returns a status + # of ''Stopping'' until the deployment is stopped. You cannot start + # a new bulk deployment while a previous deployment is in the + # ''Stopping'' state. This action doesn't rollback completed + # deployments or cancel pending deployments. + # + # @option params [required, String] :bulk_deployment_id + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.stop_bulk_deployment({ + # bulk_deployment_id: "__string", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/StopBulkDeployment AWS API Documentation + # + # @overload stop_bulk_deployment(params = {}) + # @param [Hash] params ({}) + def stop_bulk_deployment(params = {}, options = {}) + req = build_request(:stop_bulk_deployment, 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 @@ -3086,10 +3305,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-greengrass' - context[:gem_version] = '1.9.0' + context[:gem_version] = '1.10.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated