aws-sdk-iot 1.131.0 → 1.133.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0adf8bae8f18fad1418acc90634823a4314a49ca2c66119feae33e98f3bf3b1f
-  data.tar.gz: 01113f309d9ba570078786d09e9bb85055c0f0733be9e422b09d9857bd7ac648
+  metadata.gz: 2d4484d2e87faa3ac80c80f5243d4fb4db7e8436318331d32feafa3714e0efc6
+  data.tar.gz: 115c9a711e4e3c85b7b830716f17367562c405c1756421e3e07f50ae46f1902e
 SHA512:
-  metadata.gz: 98c71729b1d946b7b303f099f12c1ff461a14d5e0bbe64b1890245b5930729724ab175c236f3f1f7000bac2a860a504ae4be73e0cfe995f19b3eb90f182cf65c
-  data.tar.gz: 22f226bff6ca613b384cf6807c251af9cd9886531df5aa15fe6429f49df3f46598b36d1ca06a7275be4abb8f47e4236fbf52e92268df4beb26e6ec45c903b4e6
+  metadata.gz: 158d9ede09fb0e5010538e2b79157c03b92cc790ab44548c0a5b93b44b94b076709612704163d3606ee64a05f8675f7a8b6d06d8d66921cfa80770b88e00e0a8
+  data.tar.gz: 2134ea93029721abefc0b8bfcd2e4159c2c478222e74ae736ea265b33167c91de86ac7ed5901b62d250c0e100ae85b39dc5ad877ecc41c7540365d9dd676790f

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.133.0 (2024-09-20)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.132.0 (2024-09-16)
+------------------
+
+* Feature - This release adds additional enhancements to AWS IoT Device Management Software Package Catalog and Jobs. It also adds SBOM support in Software Package Version.
+
 1.131.0 (2024-09-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.131.0
+1.133.0

data/lib/aws-sdk-iot/client.rb

@@ -130,13 +130,15 @@ module Aws::IoT
     #     locations will be searched for credentials:
     #
     #     * `Aws.config[:credentials]`
-    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
-    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
+    #       `:account_id` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
+    #       ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
     #       enable retries and extended timeouts. Instance profile credential
     #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
     #       to true.
@@ -155,6 +157,8 @@ module Aws::IoT
     #
     #   @option options [String] :access_key_id
     #
+    #   @option options [String] :account_id
+    #
     #   @option options [Boolean] :active_endpoint_cache (false)
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
@@ -369,7 +373,9 @@ module Aws::IoT
     #     sending the request.
     #
     #   @option options [Aws::IoT::EndpointProvider] :endpoint_provider
-    #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IoT::EndpointParameters`
+    #     The endpoint provider used to resolve endpoints. Any object that responds to
+    #     `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
+    #     `Aws::IoT::EndpointParameters`.
     #
     #   @option options [Float] :http_continue_timeout (1)
     #     The number of seconds to wait for a 100-continue response before sending the
@@ -567,6 +573,72 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Associates a software bill of materials (SBOM) with a specific
+    # software package version.
+    #
+    # Requires permission to access the [AssociateSbomWithPackageVersion][1]
+    # action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
+    # @option params [required, String] :package_name
+    #   The name of the new software package.
+    #
+    # @option params [required, String] :version_name
+    #   The name of the new package version.
+    #
+    # @option params [required, Types::Sbom] :sbom
+    #   The Amazon S3 location for the software bill of materials associated
+    #   with a software package version.
+    #
+    # @option params [String] :client_token
+    #   A unique case-sensitive identifier that you can provide to ensure the
+    #   idempotency of the request. Don't reuse this client token if a new
+    #   idempotent request is required.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::AssociateSbomWithPackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::AssociateSbomWithPackageVersionResponse#package_name #package_name} => String
+    #   * {Types::AssociateSbomWithPackageVersionResponse#version_name #version_name} => String
+    #   * {Types::AssociateSbomWithPackageVersionResponse#sbom #sbom} => Types::Sbom
+    #   * {Types::AssociateSbomWithPackageVersionResponse#sbom_validation_status #sbom_validation_status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_sbom_with_package_version({
+    #     package_name: "PackageName", # required
+    #     version_name: "VersionName", # required
+    #     sbom: { # required
+    #       s3_location: {
+    #         bucket: "S3Bucket",
+    #         key: "S3Key",
+    #         version: "S3Version",
+    #       },
+    #     },
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.package_name #=> String
+    #   resp.version_name #=> String
+    #   resp.sbom.s3_location.bucket #=> String
+    #   resp.sbom.s3_location.key #=> String
+    #   resp.sbom.s3_location.version #=> String
+    #   resp.sbom_validation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
+    #
+    # @overload associate_sbom_with_package_version(params = {})
+    # @param [Hash] params ({})
+    def associate_sbom_with_package_version(params = {}, options = {})
+      req = build_request(:associate_sbom_with_package_version, params)
+      req.send_request(options)
+    end
+
     # Associates a group with a continuous job. The following criteria must
     # be met:
     #
@@ -2616,6 +2688,15 @@ module Aws::IoT
     #   The combined size of all the attributes on a package version is
     #   limited to 3KB.
     #
+    # @option params [Types::PackageVersionArtifact] :artifact
+    #   The various build components created during the build process such as
+    #   libraries and configuration files that make up a software package
+    #   version.
+    #
+    # @option params [String] :recipe
+    #   The inline job document associated with a software package version
+    #   used for a quick job deployment via IoT Jobs.
+    #
     # @option params [Hash<String,String>] :tags
     #   Metadata that can be used to manage the package version.
     #
@@ -2646,6 +2727,14 @@ module Aws::IoT
     #     attributes: {
     #       "ResourceAttributeKey" => "ResourceAttributeValue",
     #     },
+    #     artifact: {
+    #       s3_location: {
+    #         bucket: "S3Bucket",
+    #         key: "S3Key",
+    #         version: "S3Version",
+    #       },
+    #     },
+    #     recipe: "PackageVersionRecipe",
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -6163,6 +6252,10 @@ module Aws::IoT
     # @option params [required, String] :job_id
     #   The unique identifier you assigned to this job when it was created.
     #
+    # @option params [Boolean] :before_substitution
+    #   A flag that provides a view of the job document before and after the
+    #   substitution parameters have been resolved with their exact values.
+    #
     # @return [Types::DescribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeJobResponse#document_source #document_source} => String
@@ -6172,6 +6265,7 @@ module Aws::IoT
     #
     #   resp = client.describe_job({
     #     job_id: "JobId", # required
+    #     before_substitution: false,
     #   })
     #
     # @example Response structure
@@ -7137,6 +7231,47 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Disassociates a software bill of materials (SBOM) from a specific
+    # software package version.
+    #
+    # Requires permission to access the
+    # [DisassociateSbomWithPackageVersion][1] action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
+    # @option params [required, String] :package_name
+    #   The name of the new software package.
+    #
+    # @option params [required, String] :version_name
+    #   The name of the new package version.
+    #
+    # @option params [String] :client_token
+    #   A unique case-sensitive identifier that you can provide to ensure the
+    #   idempotency of the request. Don't reuse this client token if a new
+    #   idempotent request is required.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_sbom_from_package_version({
+    #     package_name: "PackageName", # required
+    #     version_name: "VersionName", # required
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @overload disassociate_sbom_from_package_version(params = {})
+    # @param [Hash] params ({})
+    def disassociate_sbom_from_package_version(params = {}, options = {})
+      req = build_request(:disassociate_sbom_from_package_version, params)
+      req.send_request(options)
+    end
+
     # Enables the rule.
     #
     # Requires permission to access the [EnableTopicRule][1] action.
@@ -7423,6 +7558,10 @@ module Aws::IoT
     # @option params [required, String] :job_id
     #   The unique identifier you assigned to this job when it was created.
     #
+    # @option params [Boolean] :before_substitution
+    #   A flag that provides a view of the job document before and after the
+    #   substitution parameters have been resolved with their exact values.
+    #
     # @return [Types::GetJobDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetJobDocumentResponse#document #document} => String
@@ -7431,6 +7570,7 @@ module Aws::IoT
     #
     #   resp = client.get_job_document({
     #     job_id: "JobId", # required
+    #     before_substitution: false,
     #   })
     #
     # @example Response structure
@@ -7637,10 +7777,14 @@ module Aws::IoT
     #   * {Types::GetPackageVersionResponse#version_name #version_name} => String
     #   * {Types::GetPackageVersionResponse#description #description} => String
     #   * {Types::GetPackageVersionResponse#attributes #attributes} => Hash&lt;String,String&gt;
+    #   * {Types::GetPackageVersionResponse#artifact #artifact} => Types::PackageVersionArtifact
     #   * {Types::GetPackageVersionResponse#status #status} => String
     #   * {Types::GetPackageVersionResponse#error_reason #error_reason} => String
     #   * {Types::GetPackageVersionResponse#creation_date #creation_date} => Time
     #   * {Types::GetPackageVersionResponse#last_modified_date #last_modified_date} => Time
+    #   * {Types::GetPackageVersionResponse#sbom #sbom} => Types::Sbom
+    #   * {Types::GetPackageVersionResponse#sbom_validation_status #sbom_validation_status} => String
+    #   * {Types::GetPackageVersionResponse#recipe #recipe} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -7657,10 +7801,18 @@ module Aws::IoT
     #   resp.description #=> String
     #   resp.attributes #=> Hash
     #   resp.attributes["ResourceAttributeKey"] #=> String
+    #   resp.artifact.s3_location.bucket #=> String
+    #   resp.artifact.s3_location.key #=> String
+    #   resp.artifact.s3_location.version #=> String
     #   resp.status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
     #   resp.error_reason #=> String
     #   resp.creation_date #=> Time
     #   resp.last_modified_date #=> Time
+    #   resp.sbom.s3_location.bucket #=> String
+    #   resp.sbom.s3_location.key #=> String
+    #   resp.sbom.s3_location.version #=> String
+    #   resp.sbom_validation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
+    #   resp.recipe #=> String
     #
     # @overload get_package_version(params = {})
     # @param [Hash] params ({})
@@ -10656,6 +10808,65 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # The validation results for all software bill of materials (SBOM)
+    # attached to a specific software package version.
+    #
+    # Requires permission to access the [ListSbomValidationResults][1]
+    # action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
+    # @option params [required, String] :package_name
+    #   The name of the new software package.
+    #
+    # @option params [required, String] :version_name
+    #   The name of the new package version.
+    #
+    # @option params [String] :validation_result
+    #   The end result of the
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return at one time.
+    #
+    # @option params [String] :next_token
+    #   A token that can be used to retrieve the next set of results, or null
+    #   if there are no additional results.
+    #
+    # @return [Types::ListSbomValidationResultsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListSbomValidationResultsResponse#validation_result_summaries #validation_result_summaries} => Array&lt;Types::SbomValidationResultSummary&gt;
+    #   * {Types::ListSbomValidationResultsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_sbom_validation_results({
+    #     package_name: "PackageName", # required
+    #     version_name: "VersionName", # required
+    #     validation_result: "FAILED", # accepts FAILED, SUCCEEDED
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.validation_result_summaries #=> Array
+    #   resp.validation_result_summaries[0].file_name #=> String
+    #   resp.validation_result_summaries[0].validation_result #=> String, one of "FAILED", "SUCCEEDED"
+    #   resp.validation_result_summaries[0].error_code #=> String, one of "INCOMPATIBLE_FORMAT", "FILE_SIZE_LIMIT_EXCEEDED"
+    #   resp.validation_result_summaries[0].error_message #=> String
+    #   resp.next_token #=> String
+    #
+    # @overload list_sbom_validation_results(params = {})
+    # @param [Hash] params ({})
+    def list_sbom_validation_results(params = {}, options = {})
+      req = build_request(:list_sbom_validation_results, params)
+      req.send_request(options)
+    end
+
     # Lists all of your scheduled audits.
     #
     # Requires permission to access the [ListScheduledAudits][1] action.
@@ -14450,6 +14661,9 @@ module Aws::IoT
     #   The combined size of all the attributes on a package version is
     #   limited to 3KB.
     #
+    # @option params [Types::PackageVersionArtifact] :artifact
+    #   The various components that make up a software package version.
+    #
     # @option params [String] :action
     #   The status that the package version should be assigned. For more
     #   information, see [Package version lifecycle][1].
@@ -14458,6 +14672,10 @@ module Aws::IoT
     #
     #   [1]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
     #
+    # @option params [String] :recipe
+    #   The inline job document associated with a software package version
+    #   used for a quick job deployment via IoT Jobs.
+    #
     # @option params [String] :client_token
     #   A unique case-sensitive identifier that you can provide to ensure the
     #   idempotency of the request. Don't reuse this client token if a new
@@ -14477,7 +14695,15 @@ module Aws::IoT
     #     attributes: {
     #       "ResourceAttributeKey" => "ResourceAttributeValue",
     #     },
+    #     artifact: {
+    #       s3_location: {
+    #         bucket: "S3Bucket",
+    #         key: "S3Key",
+    #         version: "S3Version",
+    #       },
+    #     },
     #     action: "PUBLISH", # accepts PUBLISH, DEPRECATE
+    #     recipe: "PackageVersionRecipe",
     #     client_token: "ClientToken",
     #   })
     #
@@ -15207,7 +15433,7 @@ module Aws::IoT
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.131.0'
+      context[:gem_version] = '1.133.0'
       Seahorse::Client::Request.new(handlers, context)
     end