# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
require 'seahorse/client/plugins/content_length.rb'
require 'aws-sdk-core/plugins/credentials_configuration.rb'
require 'aws-sdk-core/plugins/logging.rb'
require 'aws-sdk-core/plugins/param_converter.rb'
require 'aws-sdk-core/plugins/param_validator.rb'
require 'aws-sdk-core/plugins/user_agent.rb'
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
require 'aws-sdk-core/plugins/retry_errors.rb'
require 'aws-sdk-core/plugins/global_configuration.rb'
require 'aws-sdk-core/plugins/regional_endpoint.rb'
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
require 'aws-sdk-core/plugins/invocation_id.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
require 'aws-sdk-core/plugins/request_compression.rb'
require 'aws-sdk-core/plugins/defaults_mode.rb'
require 'aws-sdk-core/plugins/recursion_detection.rb'
require 'aws-sdk-core/plugins/telemetry.rb'
require 'aws-sdk-core/plugins/sign.rb'
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:auditmanager)
module Aws::AuditManager
# An API client for AuditManager. To construct a client, you need to configure a `:region` and `:credentials`.
#
# client = Aws::AuditManager::Client.new(
# region: region_name,
# credentials: credentials,
# # ...
# )
#
# For details on configuring region and credentials see
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
#
# See {#initialize} for a full list of supported configuration options.
class Client < Seahorse::Client::Base
include Aws::ClientStubs
@identifier = :auditmanager
set_api(ClientApi::API)
add_plugin(Seahorse::Client::Plugins::ContentLength)
add_plugin(Aws::Plugins::CredentialsConfiguration)
add_plugin(Aws::Plugins::Logging)
add_plugin(Aws::Plugins::ParamConverter)
add_plugin(Aws::Plugins::ParamValidator)
add_plugin(Aws::Plugins::UserAgent)
add_plugin(Aws::Plugins::HelpfulSocketErrors)
add_plugin(Aws::Plugins::RetryErrors)
add_plugin(Aws::Plugins::GlobalConfiguration)
add_plugin(Aws::Plugins::RegionalEndpoint)
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
add_plugin(Aws::Plugins::InvocationId)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
add_plugin(Aws::Plugins::ChecksumAlgorithm)
add_plugin(Aws::Plugins::RequestCompression)
add_plugin(Aws::Plugins::DefaultsMode)
add_plugin(Aws::Plugins::RecursionDetection)
add_plugin(Aws::Plugins::Telemetry)
add_plugin(Aws::Plugins::Sign)
add_plugin(Aws::Plugins::Protocols::RestJson)
add_plugin(Aws::AuditManager::Plugins::Endpoints)
# @overload initialize(options)
# @param [Hash] options
#
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
# A list of plugins to apply to the client. Each plugin is either a
# class name or an instance of a plugin class.
#
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
# following classes:
#
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
# * `Aws::SharedCredentials` - Used for loading static credentials from a
# shared file, such as `~/.aws/config`.
#
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
#
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
# assume a role after providing credentials via the web.
#
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
# access token generated from `aws login`.
#
# * `Aws::ProcessCredentials` - Used for loading credentials from a
# process that outputs to stdout.
#
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
# * `Aws::ECSCredentials` - Used for loading credentials from
# instances running in ECS.
#
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
# from the Cognito Identity service.
#
# When `:credentials` are not configured directly, the following
# 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']
# * `~/.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
# enable retries and extended timeouts. Instance profile credential
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
# to true.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
# used to determine the service `:endpoint`. When not passed,
# a default `:region` is searched for in the following locations:
#
# * `Aws.config[:region]`
# * `ENV['AWS_REGION']`
# * `ENV['AMAZON_REGION']`
# * `ENV['AWS_DEFAULT_REGION']`
# * `~/.aws/credentials`
# * `~/.aws/config`
#
# @option options [String] :access_key_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`.
#
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
# Used only in `adaptive` retry mode. When true, the request will sleep
# until there is sufficent client side capacity to retry the request.
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
# not retry instead of sleeping.
#
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
# Allows you to provide an identifier for this client which will be attached to
# all generated client side metrics. Defaults to an empty string.
#
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
# side monitoring agent is running on, where client metrics will be published via UDP.
#
# @option options [Integer] :client_side_monitoring_port (31000)
# Required for publishing client metrics. The port that the client side monitoring
# agent is running on, where client metrics will be published via UDP.
#
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
# Allows you to provide a custom client-side monitoring publisher class. By default,
# will use the Client Side Monitoring Agent Publisher.
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
# @option options [Boolean] :correct_clock_skew (true)
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
# a clock skew correction and retry requests with skewed client clocks.
#
# @option options [String] :defaults_mode ("legacy")
# See {Aws::DefaultsModeConfiguration} for a list of the
# accepted modes and the configuration defaults that are included.
#
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
# @option options [Boolean] :disable_request_compression (false)
# When set to 'true' the request body will not be compressed
# for supported operations.
#
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
# Normally you should not configure the `:endpoint` option
# directly. This is normally constructed from the `:region`
# option. Configuring `:endpoint` is normally reserved for
# connecting to test or custom endpoints. The endpoint should
# be a URI formatted like:
#
# 'http://example.com'
# 'https://example.com'
# 'http://example.com:123'
#
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
#
# @option options [Integer] :endpoint_cache_poll_interval (60)
# When :endpoint_discovery and :active_endpoint_cache is enabled,
# Use this option to config the time interval in seconds for making
# requests fetching endpoints information. Defaults to 60 sec.
#
# @option options [Boolean] :endpoint_discovery (false)
# When set to `true`, endpoint discovery will be enabled for operations when available.
#
# @option options [Boolean] :ignore_configured_endpoint_urls
# Setting to true disables use of endpoint URLs provided via environment
# variables and the shared configuration file.
#
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
#
# @option options [Symbol] :log_level (:info)
# The log level to send messages to the `:logger` at.
#
# @option options [Logger] :logger
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
# @option options [Integer] :max_attempts (3)
# An integer representing the maximum number attempts that will be made for
# a single request, including the initial attempt. For example,
# setting this value to 5 will result in a request being retried up to
# 4 times. Used in `standard` and `adaptive` retry modes.
#
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
# @option options [Integer] :request_min_compression_size_bytes (10240)
# The minimum size in bytes that triggers compression for request
# bodies. The value must be non-negative integer value between 0
# and 10485780 bytes inclusive.
#
# @option options [Proc] :retry_backoff
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
# This option is only used in the `legacy` retry mode.
#
# @option options [Float] :retry_base_delay (0.3)
# The base delay in seconds used by the default backoff function. This option
# is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (:none)
# A delay randomiser function used by the default backoff function.
# Some predefined functions can be referenced by name - :none, :equal, :full,
# otherwise a Proc that takes and returns a number. This option is only used
# in the `legacy` retry mode.
#
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
#
# @option options [Integer] :retry_limit (3)
# The maximum number of times to retry failed requests. Only
# ~ 500 level server errors and certain ~ 400 level client errors
# are retried. Generally, these are throttling errors, data
# checksum errors, networking errors, timeout errors, auth errors,
# endpoint discovery, and errors from expired credentials.
# This option is only used in the `legacy` retry mode.
#
# @option options [Integer] :retry_max_delay (0)
# The maximum number of seconds to delay between retries (0 for no limit)
# used by the default backoff function. This option is only used in the
# `legacy` retry mode.
#
# @option options [String] :retry_mode ("legacy")
# Specifies which retry algorithm to use. Values are:
#
# * `legacy` - The pre-existing retry behavior. This is default value if
# no retry mode is provided.
#
# * `standard` - A standardized set of retry rules across the AWS SDKs.
# This includes support for retry quotas, which limit the number of
# unsuccessful retries a client can make.
#
# * `adaptive` - An experimental retry mode that includes all the
# functionality of `standard` mode along with automatic client side
# throttling. This is a provisional mode that may change behavior
# in the future.
#
# @option options [String] :sdk_ua_app_id
# A unique and opaque application ID that is appended to the
# User-Agent header as app/sdk_ua_app_id. It should have a
# maximum length of 50. This variable is sourced from environment
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
#
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Array] :sigv4a_signing_region_set
# A list of regions that should be signed with SigV4a signing. When
# not passed, a default `:sigv4a_signing_region_set` is searched for
# in the following locations:
#
# * `Aws.config[:sigv4a_signing_region_set]`
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
# * `~/.aws/config`
#
# @option options [Boolean] :stub_responses (false)
# Causes the client to return stubbed responses. By default
# fake responses are generated and returned. You can specify
# the response data to return or errors to raise by calling
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
#
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
# Allows you to provide a telemetry provider, which is used to
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
# will not record or emit any telemetry data. The SDK supports the
# following telemetry providers:
#
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
# `opentelemetry-sdk` gem and then, pass in an instance of a
# `Aws::Telemetry::OTelProvider` for telemetry provider.
#
# @option options [Aws::TokenProvider] :token_provider
# A Bearer Token Provider. This can be an instance of any one of the
# following classes:
#
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
# tokens.
#
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
# access token generated from `aws login`.
#
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
# will be used to search for tokens configured for your profile in shared configuration files.
#
# @option options [Boolean] :use_dualstack_endpoint
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
# will be used if available.
#
# @option options [Boolean] :use_fips_endpoint
# When set to `true`, fips compatible endpoints will be used if available.
# When a `fips` region is used, the region is normalized and this config
# is set to `true`.
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
# @option options [Aws::AuditManager::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::AuditManager::EndpointParameters`
#
# @option options [Float] :http_continue_timeout (1)
# The number of seconds to wait for a 100-continue response before sending the
# request body. This option has no effect unless the request has "Expect"
# header set to "100-continue". Defaults to `nil` which disables this
# behaviour. This value can safely be set per request on the session.
#
# @option options [Float] :http_idle_timeout (5)
# The number of seconds a connection is allowed to sit idle before it
# is considered stale. Stale connections are closed and removed from the
# pool before making a request.
#
# @option options [Float] :http_open_timeout (15)
# The default number of seconds to wait for response data.
# This value can safely be set per-request on the session.
#
# @option options [URI::HTTP,String] :http_proxy
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_read_timeout (60)
# The default number of seconds to wait for response data.
# This value can safely be set per-request on the session.
#
# @option options [Boolean] :http_wire_trace (false)
# When `true`, HTTP debug output will be sent to the `:logger`.
#
# @option options [Proc] :on_chunk_received
# When a Proc object is provided, it will be used as callback when each chunk
# of the response body is received. It provides three arguments: the chunk,
# the number of bytes received, and the total number of
# bytes in the response (or nil if the server did not send a `content-length`).
#
# @option options [Proc] :on_chunk_sent
# When a Proc object is provided, it will be used as callback when each chunk
# of the request body is sent. It provides three arguments: the chunk,
# the number of bytes read from the body, and the total number of
# bytes in the body.
#
# @option options [Boolean] :raise_response_errors (true)
# When `true`, response errors are raised.
#
# @option options [String] :ssl_ca_bundle
# Full path to the SSL certificate authority bundle file that should be used when
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
# `:ssl_ca_directory` the the system default will be used if available.
#
# @option options [String] :ssl_ca_directory
# Full path of the directory that contains the unbundled SSL certificate
# authority files for verifying peer certificates. If you do
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
# default will be used if available.
#
# @option options [String] :ssl_ca_store
# Sets the X509::Store to verify peer certificate.
#
# @option options [OpenSSL::X509::Certificate] :ssl_cert
# Sets a client certificate when creating http connections.
#
# @option options [OpenSSL::PKey] :ssl_key
# Sets a client key when creating http connections.
#
# @option options [Float] :ssl_timeout
# Sets the SSL timeout in seconds
#
# @option options [Boolean] :ssl_verify_peer (true)
# When `true`, SSL peer certificates are verified when establishing a connection.
#
def initialize(*args)
super
end
# @!group API Operations
# Associates an evidence folder to an assessment report in an Audit
# Manager assessment.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :evidence_folder_id
# The identifier for the folder that the evidence is stored in.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.associate_assessment_report_evidence_folder({
# assessment_id: "UUID", # required
# evidence_folder_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder AWS API Documentation
#
# @overload associate_assessment_report_evidence_folder(params = {})
# @param [Hash] params ({})
def associate_assessment_report_evidence_folder(params = {}, options = {})
req = build_request(:associate_assessment_report_evidence_folder, params)
req.send_request(options)
end
# Associates a list of evidence to an assessment report in an Audit
# Manager assessment.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :evidence_folder_id
# The identifier for the folder that the evidence is stored in.
#
# @option params [required, Array<String>] :evidence_ids
# The list of evidence identifiers.
#
# @return [Types::BatchAssociateAssessmentReportEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchAssociateAssessmentReportEvidenceResponse#evidence_ids #evidence_ids} => Array<String>
# * {Types::BatchAssociateAssessmentReportEvidenceResponse#errors #errors} => Array<Types::AssessmentReportEvidenceError>
#
# @example Request syntax with placeholder values
#
# resp = client.batch_associate_assessment_report_evidence({
# assessment_id: "UUID", # required
# evidence_folder_id: "UUID", # required
# evidence_ids: ["UUID"], # required
# })
#
# @example Response structure
#
# resp.evidence_ids #=> Array
# resp.evidence_ids[0] #=> String
# resp.errors #=> Array
# resp.errors[0].evidence_id #=> String
# resp.errors[0].error_code #=> String
# resp.errors[0].error_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence AWS API Documentation
#
# @overload batch_associate_assessment_report_evidence(params = {})
# @param [Hash] params ({})
def batch_associate_assessment_report_evidence(params = {}, options = {})
req = build_request(:batch_associate_assessment_report_evidence, params)
req.send_request(options)
end
# Creates a batch of delegations for an assessment in Audit Manager.
#
# @option params [required, Array<Types::CreateDelegationRequest>] :create_delegation_requests
# The API request to batch create delegations in Audit Manager.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @return [Types::BatchCreateDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchCreateDelegationByAssessmentResponse#delegations #delegations} => Array<Types::Delegation>
# * {Types::BatchCreateDelegationByAssessmentResponse#errors #errors} => Array<Types::BatchCreateDelegationByAssessmentError>
#
# @example Request syntax with placeholder values
#
# resp = client.batch_create_delegation_by_assessment({
# create_delegation_requests: [ # required
# {
# comment: "DelegationComment",
# control_set_id: "ControlSetId",
# role_arn: "IamArn",
# role_type: "PROCESS_OWNER", # accepts PROCESS_OWNER, RESOURCE_OWNER
# },
# ],
# assessment_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.delegations #=> Array
# resp.delegations[0].id #=> String
# resp.delegations[0].assessment_name #=> String
# resp.delegations[0].assessment_id #=> String
# resp.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.delegations[0].role_arn #=> String
# resp.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.delegations[0].creation_time #=> Time
# resp.delegations[0].last_updated #=> Time
# resp.delegations[0].control_set_id #=> String
# resp.delegations[0].comment #=> String
# resp.delegations[0].created_by #=> String
# resp.errors #=> Array
# resp.errors[0].create_delegation_request.comment #=> String
# resp.errors[0].create_delegation_request.control_set_id #=> String
# resp.errors[0].create_delegation_request.role_arn #=> String
# resp.errors[0].create_delegation_request.role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.errors[0].error_code #=> String
# resp.errors[0].error_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchCreateDelegationByAssessment AWS API Documentation
#
# @overload batch_create_delegation_by_assessment(params = {})
# @param [Hash] params ({})
def batch_create_delegation_by_assessment(params = {}, options = {})
req = build_request(:batch_create_delegation_by_assessment, params)
req.send_request(options)
end
# Deletes a batch of delegations for an assessment in Audit Manager.
#
# @option params [required, Array<String>] :delegation_ids
# The identifiers for the delegations.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @return [Types::BatchDeleteDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchDeleteDelegationByAssessmentResponse#errors #errors} => Array<Types::BatchDeleteDelegationByAssessmentError>
#
# @example Request syntax with placeholder values
#
# resp = client.batch_delete_delegation_by_assessment({
# delegation_ids: ["UUID"], # required
# assessment_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.errors #=> Array
# resp.errors[0].delegation_id #=> String
# resp.errors[0].error_code #=> String
# resp.errors[0].error_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment AWS API Documentation
#
# @overload batch_delete_delegation_by_assessment(params = {})
# @param [Hash] params ({})
def batch_delete_delegation_by_assessment(params = {}, options = {})
req = build_request(:batch_delete_delegation_by_assessment, params)
req.send_request(options)
end
# Disassociates a list of evidence from an assessment report in Audit
# Manager.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :evidence_folder_id
# The identifier for the folder that the evidence is stored in.
#
# @option params [required, Array<String>] :evidence_ids
# The list of evidence identifiers.
#
# @return [Types::BatchDisassociateAssessmentReportEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchDisassociateAssessmentReportEvidenceResponse#evidence_ids #evidence_ids} => Array<String>
# * {Types::BatchDisassociateAssessmentReportEvidenceResponse#errors #errors} => Array<Types::AssessmentReportEvidenceError>
#
# @example Request syntax with placeholder values
#
# resp = client.batch_disassociate_assessment_report_evidence({
# assessment_id: "UUID", # required
# evidence_folder_id: "UUID", # required
# evidence_ids: ["UUID"], # required
# })
#
# @example Response structure
#
# resp.evidence_ids #=> Array
# resp.evidence_ids[0] #=> String
# resp.errors #=> Array
# resp.errors[0].evidence_id #=> String
# resp.errors[0].error_code #=> String
# resp.errors[0].error_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence AWS API Documentation
#
# @overload batch_disassociate_assessment_report_evidence(params = {})
# @param [Hash] params ({})
def batch_disassociate_assessment_report_evidence(params = {}, options = {})
req = build_request(:batch_disassociate_assessment_report_evidence, params)
req.send_request(options)
end
# Adds one or more pieces of evidence to a control in an Audit Manager
# assessment.
#
# You can import manual evidence from any S3 bucket by specifying the S3
# URI of the object. You can also upload a file from your browser, or
# enter plain text in response to a risk assessment question.
#
# The following restrictions apply to this action:
#
# * `manualEvidence` can be only one of the following:
# `evidenceFileName`, `s3ResourcePath`, or `textResponse`
#
# * Maximum size of an individual evidence file: 100 MB
#
# * Number of daily manual evidence uploads per control: 100
#
# * Supported file formats: See [Supported file types for manual
# evidence][1] in the *Audit Manager User Guide*
#
# For more information about Audit Manager service restrictions, see
# [Quotas and restrictions for Audit Manager][2].
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files
# [2]: https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The identifier for the control set.
#
# @option params [required, String] :control_id
# The identifier for the control.
#
# @option params [required, Array<Types::ManualEvidence>] :manual_evidence
# The list of manual evidence objects.
#
# @return [Types::BatchImportEvidenceToAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchImportEvidenceToAssessmentControlResponse#errors #errors} => Array<Types::BatchImportEvidenceToAssessmentControlError>
#
# @example Request syntax with placeholder values
#
# resp = client.batch_import_evidence_to_assessment_control({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# control_id: "UUID", # required
# manual_evidence: [ # required
# {
# s3_resource_path: "S3Url",
# text_response: "ManualEvidenceTextResponse",
# evidence_file_name: "ManualEvidenceLocalFileName",
# },
# ],
# })
#
# @example Response structure
#
# resp.errors #=> Array
# resp.errors[0].manual_evidence.s3_resource_path #=> String
# resp.errors[0].manual_evidence.text_response #=> String
# resp.errors[0].manual_evidence.evidence_file_name #=> String
# resp.errors[0].error_code #=> String
# resp.errors[0].error_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl AWS API Documentation
#
# @overload batch_import_evidence_to_assessment_control(params = {})
# @param [Hash] params ({})
def batch_import_evidence_to_assessment_control(params = {}, options = {})
req = build_request(:batch_import_evidence_to_assessment_control, params)
req.send_request(options)
end
# Creates an assessment in Audit Manager.
#
# @option params [required, String] :name
# The name of the assessment to be created.
#
# @option params [String] :description
# The optional description of the assessment to be created.
#
# @option params [required, Types::AssessmentReportsDestination] :assessment_reports_destination
# The assessment report storage destination for the assessment that's
# being created.
#
# @option params [required, Types::Scope] :scope
# The wrapper that contains the Amazon Web Services accounts that are in
# scope for the assessment.
#
# <note markdown="1"> You no longer need to specify which Amazon Web Services are in scope
# when you create or update an assessment. Audit Manager infers the
# services in scope by examining your assessment controls and their data
# sources, and then mapping this information to the relevant Amazon Web
# Services.
#
# If an underlying data source changes for your assessment, we
# automatically update the services scope as needed to reflect the
# correct Amazon Web Services. This ensures that your assessment
# collects accurate and comprehensive evidence about all of the relevant
# services in your AWS environment.
#
# </note>
#
# @option params [required, Array<Types::Role>] :roles
# The list of roles for the assessment.
#
# @option params [required, String] :framework_id
# The identifier for the framework that the assessment will be created
# from.
#
# @option params [Hash<String,String>] :tags
# The tags that are associated with the assessment.
#
# @return [Types::CreateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateAssessmentResponse#assessment #assessment} => Types::Assessment
#
# @example Request syntax with placeholder values
#
# resp = client.create_assessment({
# name: "AssessmentName", # required
# description: "AssessmentDescription",
# assessment_reports_destination: { # required
# destination_type: "S3", # accepts S3
# destination: "S3Url",
# },
# scope: { # required
# aws_accounts: [
# {
# id: "AccountId",
# email_address: "EmailAddress",
# name: "AccountName",
# },
# ],
# aws_services: [
# {
# service_name: "AWSServiceName",
# },
# ],
# },
# roles: [ # required
# {
# role_type: "PROCESS_OWNER", # required, accepts PROCESS_OWNER, RESOURCE_OWNER
# role_arn: "IamArn", # required
# },
# ],
# framework_id: "UUID", # required
# tags: {
# "TagKey" => "TagValue",
# },
# })
#
# @example Response structure
#
# resp.assessment.arn #=> String
# resp.assessment.aws_account.id #=> String
# resp.assessment.aws_account.email_address #=> String
# resp.assessment.aws_account.name #=> String
# resp.assessment.metadata.name #=> String
# resp.assessment.metadata.id #=> String
# resp.assessment.metadata.description #=> String
# resp.assessment.metadata.compliance_type #=> String
# resp.assessment.metadata.status #=> String, one of "ACTIVE", "INACTIVE"
# resp.assessment.metadata.assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.assessment.metadata.assessment_reports_destination.destination #=> String
# resp.assessment.metadata.scope.aws_accounts #=> Array
# resp.assessment.metadata.scope.aws_accounts[0].id #=> String
# resp.assessment.metadata.scope.aws_accounts[0].email_address #=> String
# resp.assessment.metadata.scope.aws_accounts[0].name #=> String
# resp.assessment.metadata.scope.aws_services #=> Array
# resp.assessment.metadata.scope.aws_services[0].service_name #=> String
# resp.assessment.metadata.roles #=> Array
# resp.assessment.metadata.roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.roles[0].role_arn #=> String
# resp.assessment.metadata.delegations #=> Array
# resp.assessment.metadata.delegations[0].id #=> String
# resp.assessment.metadata.delegations[0].assessment_name #=> String
# resp.assessment.metadata.delegations[0].assessment_id #=> String
# resp.assessment.metadata.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.metadata.delegations[0].role_arn #=> String
# resp.assessment.metadata.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.delegations[0].creation_time #=> Time
# resp.assessment.metadata.delegations[0].last_updated #=> Time
# resp.assessment.metadata.delegations[0].control_set_id #=> String
# resp.assessment.metadata.delegations[0].comment #=> String
# resp.assessment.metadata.delegations[0].created_by #=> String
# resp.assessment.metadata.creation_time #=> Time
# resp.assessment.metadata.last_updated #=> Time
# resp.assessment.framework.id #=> String
# resp.assessment.framework.arn #=> String
# resp.assessment.framework.metadata.name #=> String
# resp.assessment.framework.metadata.description #=> String
# resp.assessment.framework.metadata.logo #=> String
# resp.assessment.framework.metadata.compliance_type #=> String
# resp.assessment.framework.control_sets #=> Array
# resp.assessment.framework.control_sets[0].id #=> String
# resp.assessment.framework.control_sets[0].description #=> String
# resp.assessment.framework.control_sets[0].status #=> String, one of "ACTIVE", "UNDER_REVIEW", "REVIEWED"
# resp.assessment.framework.control_sets[0].roles #=> Array
# resp.assessment.framework.control_sets[0].roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].roles[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].controls #=> Array
# resp.assessment.framework.control_sets[0].controls[0].id #=> String
# resp.assessment.framework.control_sets[0].controls[0].name #=> String
# resp.assessment.framework.control_sets[0].controls[0].description #=> String
# resp.assessment.framework.control_sets[0].controls[0].status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.assessment.framework.control_sets[0].controls[0].response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.assessment.framework.control_sets[0].controls[0].comments #=> Array
# resp.assessment.framework.control_sets[0].controls[0].comments[0].author_name #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].comment_body #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].posted_date #=> Time
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources #=> Array
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources[0] #=> String
# resp.assessment.framework.control_sets[0].controls[0].evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].controls[0].assessment_report_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].delegations #=> Array
# resp.assessment.framework.control_sets[0].delegations[0].id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_name #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.framework.control_sets[0].delegations[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].delegations[0].creation_time #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].last_updated #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].control_set_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].comment #=> String
# resp.assessment.framework.control_sets[0].delegations[0].created_by #=> String
# resp.assessment.framework.control_sets[0].system_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].manual_evidence_count #=> Integer
# resp.assessment.tags #=> Hash
# resp.assessment.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessment AWS API Documentation
#
# @overload create_assessment(params = {})
# @param [Hash] params ({})
def create_assessment(params = {}, options = {})
req = build_request(:create_assessment, params)
req.send_request(options)
end
# Creates a custom framework in Audit Manager.
#
# @option params [required, String] :name
# The name of the new custom framework.
#
# @option params [String] :description
# An optional description for the new custom framework.
#
# @option params [String] :compliance_type
# The compliance type that the new custom framework supports, such as
# CIS or HIPAA.
#
# @option params [required, Array<Types::CreateAssessmentFrameworkControlSet>] :control_sets
# The control sets that are associated with the framework.
#
# @option params [Hash<String,String>] :tags
# The tags that are associated with the framework.
#
# @return [Types::CreateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateAssessmentFrameworkResponse#framework #framework} => Types::Framework
#
# @example Request syntax with placeholder values
#
# resp = client.create_assessment_framework({
# name: "FrameworkName", # required
# description: "FrameworkDescription",
# compliance_type: "ComplianceType",
# control_sets: [ # required
# {
# name: "ControlSetName", # required
# controls: [
# {
# id: "UUID", # required
# },
# ],
# },
# ],
# tags: {
# "TagKey" => "TagValue",
# },
# })
#
# @example Response structure
#
# resp.framework.arn #=> String
# resp.framework.id #=> String
# resp.framework.name #=> String
# resp.framework.type #=> String, one of "Standard", "Custom"
# resp.framework.compliance_type #=> String
# resp.framework.description #=> String
# resp.framework.logo #=> String
# resp.framework.control_sources #=> String
# resp.framework.control_sets #=> Array
# resp.framework.control_sets[0].id #=> String
# resp.framework.control_sets[0].name #=> String
# resp.framework.control_sets[0].controls #=> Array
# resp.framework.control_sets[0].controls[0].arn #=> String
# resp.framework.control_sets[0].controls[0].id #=> String
# resp.framework.control_sets[0].controls[0].type #=> String, one of "Standard", "Custom", "Core"
# resp.framework.control_sets[0].controls[0].name #=> String
# resp.framework.control_sets[0].controls[0].description #=> String
# resp.framework.control_sets[0].controls[0].testing_information #=> String
# resp.framework.control_sets[0].controls[0].action_plan_title #=> String
# resp.framework.control_sets[0].controls[0].action_plan_instructions #=> String
# resp.framework.control_sets[0].controls[0].control_sources #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources #=> Array
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_id #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_name #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_description #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].troubleshooting_text #=> String
# resp.framework.control_sets[0].controls[0].created_at #=> Time
# resp.framework.control_sets[0].controls[0].last_updated_at #=> Time
# resp.framework.control_sets[0].controls[0].created_by #=> String
# resp.framework.control_sets[0].controls[0].last_updated_by #=> String
# resp.framework.control_sets[0].controls[0].tags #=> Hash
# resp.framework.control_sets[0].controls[0].tags["TagKey"] #=> String
# resp.framework.control_sets[0].controls[0].state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
# resp.framework.created_at #=> Time
# resp.framework.last_updated_at #=> Time
# resp.framework.created_by #=> String
# resp.framework.last_updated_by #=> String
# resp.framework.tags #=> Hash
# resp.framework.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentFramework AWS API Documentation
#
# @overload create_assessment_framework(params = {})
# @param [Hash] params ({})
def create_assessment_framework(params = {}, options = {})
req = build_request(:create_assessment_framework, params)
req.send_request(options)
end
# Creates an assessment report for the specified assessment.
#
# @option params [required, String] :name
# The name of the new assessment report.
#
# @option params [String] :description
# The description of the assessment report.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [String] :query_statement
# A SQL statement that represents an evidence finder query.
#
# Provide this parameter when you want to generate an assessment report
# from the results of an evidence finder search query. When you use this
# parameter, Audit Manager generates a one-time report using only the
# evidence from the query output. This report does not include any
# assessment evidence that was manually [added to a report using the
# console][1], or [associated with a report using the API][2].
#
# To use this parameter, the [enablementStatus][3] of evidence finder
# must be `ENABLED`.
#
# For examples and help resolving `queryStatement` validation
# exceptions, see [Troubleshooting evidence finder issues][4] in the
# *Audit Manager User Guide.*
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html
# [3]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus
# [4]: https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions
#
# @return [Types::CreateAssessmentReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateAssessmentReportResponse#assessment_report #assessment_report} => Types::AssessmentReport
#
# @example Request syntax with placeholder values
#
# resp = client.create_assessment_report({
# name: "AssessmentReportName", # required
# description: "AssessmentReportDescription",
# assessment_id: "UUID", # required
# query_statement: "QueryStatement",
# })
#
# @example Response structure
#
# resp.assessment_report.id #=> String
# resp.assessment_report.name #=> String
# resp.assessment_report.description #=> String
# resp.assessment_report.aws_account_id #=> String
# resp.assessment_report.assessment_id #=> String
# resp.assessment_report.assessment_name #=> String
# resp.assessment_report.author #=> String
# resp.assessment_report.status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
# resp.assessment_report.creation_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentReport AWS API Documentation
#
# @overload create_assessment_report(params = {})
# @param [Hash] params ({})
def create_assessment_report(params = {}, options = {})
req = build_request(:create_assessment_report, params)
req.send_request(options)
end
# Creates a new custom control in Audit Manager.
#
# @option params [required, String] :name
# The name of the control.
#
# @option params [String] :description
# The description of the control.
#
# @option params [String] :testing_information
# The steps to follow to determine if the control is satisfied.
#
# @option params [String] :action_plan_title
# The title of the action plan for remediating the control.
#
# @option params [String] :action_plan_instructions
# The recommended actions to carry out if the control isn't fulfilled.
#
# @option params [required, Array<Types::CreateControlMappingSource>] :control_mapping_sources
# The data mapping sources for the control.
#
# @option params [Hash<String,String>] :tags
# The tags that are associated with the control.
#
# @return [Types::CreateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateControlResponse#control #control} => Types::Control
#
# @example Request syntax with placeholder values
#
# resp = client.create_control({
# name: "ControlName", # required
# description: "ControlDescription",
# testing_information: "TestingInformation",
# action_plan_title: "ActionPlanTitle",
# action_plan_instructions: "ActionPlanInstructions",
# control_mapping_sources: [ # required
# {
# source_name: "SourceName",
# source_description: "SourceDescription",
# source_set_up_option: "System_Controls_Mapping", # accepts System_Controls_Mapping, Procedural_Controls_Mapping
# source_type: "AWS_Cloudtrail", # accepts AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, MANUAL, Common_Control, Core_Control
# source_keyword: {
# keyword_input_type: "SELECT_FROM_LIST", # accepts SELECT_FROM_LIST, UPLOAD_FILE, INPUT_TEXT
# keyword_value: "KeywordValue",
# },
# source_frequency: "DAILY", # accepts DAILY, WEEKLY, MONTHLY
# troubleshooting_text: "TroubleshootingText",
# },
# ],
# tags: {
# "TagKey" => "TagValue",
# },
# })
#
# @example Response structure
#
# resp.control.arn #=> String
# resp.control.id #=> String
# resp.control.type #=> String, one of "Standard", "Custom", "Core"
# resp.control.name #=> String
# resp.control.description #=> String
# resp.control.testing_information #=> String
# resp.control.action_plan_title #=> String
# resp.control.action_plan_instructions #=> String
# resp.control.control_sources #=> String
# resp.control.control_mapping_sources #=> Array
# resp.control.control_mapping_sources[0].source_id #=> String
# resp.control.control_mapping_sources[0].source_name #=> String
# resp.control.control_mapping_sources[0].source_description #=> String
# resp.control.control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.control.control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.control.control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.control.control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.control.control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.control.control_mapping_sources[0].troubleshooting_text #=> String
# resp.control.created_at #=> Time
# resp.control.last_updated_at #=> Time
# resp.control.created_by #=> String
# resp.control.last_updated_by #=> String
# resp.control.tags #=> Hash
# resp.control.tags["TagKey"] #=> String
# resp.control.state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateControl AWS API Documentation
#
# @overload create_control(params = {})
# @param [Hash] params ({})
def create_control(params = {}, options = {})
req = build_request(:create_control, params)
req.send_request(options)
end
# Deletes an assessment in Audit Manager.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_assessment({
# assessment_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessment AWS API Documentation
#
# @overload delete_assessment(params = {})
# @param [Hash] params ({})
def delete_assessment(params = {}, options = {})
req = build_request(:delete_assessment, params)
req.send_request(options)
end
# Deletes a custom framework in Audit Manager.
#
# @option params [required, String] :framework_id
# The identifier for the custom framework.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_assessment_framework({
# framework_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFramework AWS API Documentation
#
# @overload delete_assessment_framework(params = {})
# @param [Hash] params ({})
def delete_assessment_framework(params = {}, options = {})
req = build_request(:delete_assessment_framework, params)
req.send_request(options)
end
# Deletes a share request for a custom framework in Audit Manager.
#
# @option params [required, String] :request_id
# The unique identifier for the share request to be deleted.
#
# @option params [required, String] :request_type
# Specifies whether the share request is a sent request or a received
# request.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_assessment_framework_share({
# request_id: "UUID", # required
# request_type: "SENT", # required, accepts SENT, RECEIVED
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare AWS API Documentation
#
# @overload delete_assessment_framework_share(params = {})
# @param [Hash] params ({})
def delete_assessment_framework_share(params = {}, options = {})
req = build_request(:delete_assessment_framework_share, params)
req.send_request(options)
end
# Deletes an assessment report in Audit Manager.
#
# When you run the `DeleteAssessmentReport` operation, Audit Manager
# attempts to delete the following data:
#
# 1. The specified assessment report that’s stored in your S3 bucket
#
# 2. The associated metadata that’s stored in Audit Manager
#
# If Audit Manager can’t access the assessment report in your S3 bucket,
# the report isn’t deleted. In this event, the `DeleteAssessmentReport`
# operation doesn’t fail. Instead, it proceeds to delete the associated
# metadata only. You must then delete the assessment report from the S3
# bucket yourself.
#
# This scenario happens when Audit Manager receives a `403 (Forbidden)`
# or `404 (Not Found)` error from Amazon S3. To avoid this, make sure
# that your S3 bucket is available, and that you configured the correct
# permissions for Audit Manager to delete resources in your S3 bucket.
# For an example permissions policy that you can use, see [Assessment
# report destination permissions][1] in the *Audit Manager User Guide*.
# For information about the issues that could cause a `403 (Forbidden)`
# or `404 (Not Found`) error from Amazon S3, see [List of Error
# Codes][2] in the *Amazon Simple Storage Service API Reference*.
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :assessment_report_id
# The unique identifier for the assessment report.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_assessment_report({
# assessment_id: "UUID", # required
# assessment_report_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentReport AWS API Documentation
#
# @overload delete_assessment_report(params = {})
# @param [Hash] params ({})
def delete_assessment_report(params = {}, options = {})
req = build_request(:delete_assessment_report, params)
req.send_request(options)
end
# Deletes a custom control in Audit Manager.
#
# When you invoke this operation, the custom control is deleted from any
# frameworks or assessments that it’s currently part of. As a result,
# Audit Manager will stop collecting evidence for that custom control in
# all of your assessments. This includes assessments that you previously
# created before you deleted the custom control.
#
# @option params [required, String] :control_id
# The unique identifier for the control.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_control({
# control_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteControl AWS API Documentation
#
# @overload delete_control(params = {})
# @param [Hash] params ({})
def delete_control(params = {}, options = {})
req = build_request(:delete_control, params)
req.send_request(options)
end
# Deregisters an account in Audit Manager.
#
# <note markdown="1"> Before you deregister, you can use the [UpdateSettings][1] API
# operation to set your preferred data retention policy. By default,
# Audit Manager retains your data. If you want to delete your data, you
# can use the `DeregistrationPolicy` attribute to request the deletion
# of your data.
#
# For more information about data retention, see [Data Protection][2] in
# the *Audit Manager User Guide*.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html
# [2]: https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html
#
# @return [Types::DeregisterAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeregisterAccountResponse#status #status} => String
#
# @example Response structure
#
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING_ACTIVATION"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterAccount AWS API Documentation
#
# @overload deregister_account(params = {})
# @param [Hash] params ({})
def deregister_account(params = {}, options = {})
req = build_request(:deregister_account, params)
req.send_request(options)
end
# Removes the specified Amazon Web Services account as a delegated
# administrator for Audit Manager.
#
# When you remove a delegated administrator from your Audit Manager
# settings, you continue to have access to the evidence that you
# previously collected under that account. This is also the case when
# you deregister a delegated administrator from Organizations. However,
# Audit Manager stops collecting and attaching evidence to that
# delegated administrator account moving forward.
#
# Keep in mind the following cleanup task if you use evidence finder:
#
# Before you use your management account to remove a delegated
# administrator, make sure that the current delegated administrator
# account signs in to Audit Manager and disables evidence finder first.
# Disabling evidence finder automatically deletes the event data store
# that was created in their account when they enabled evidence finder.
# If this task isn’t completed, the event data store remains in their
# account. In this case, we recommend that the original delegated
# administrator goes to CloudTrail Lake and manually [deletes the event
# data store][1].
#
# This cleanup task is necessary to ensure that you don't end up with
# multiple event data stores. Audit Manager ignores an unused event data
# store after you remove or change a delegated administrator account.
# However, the unused event data store continues to incur storage costs
# from CloudTrail Lake if you don't delete it.
#
# When you deregister a delegated administrator account for Audit
# Manager, the data for that account isn’t deleted. If you want to
# delete resource data for a delegated administrator account, you must
# perform that task separately before you deregister the account.
# Either, you can do this in the Audit Manager console. Or, you can use
# one of the delete API operations that are provided by Audit Manager.
#
# To delete your Audit Manager resource data, see the following
# instructions:
#
# * [DeleteAssessment][2] (see also: [Deleting an assessment][3] in the
# *Audit Manager User Guide*)
#
# * [DeleteAssessmentFramework][4] (see also: [Deleting a custom
# framework][5] in the *Audit Manager User Guide*)
#
# * [DeleteAssessmentFrameworkShare][6] (see also: [Deleting a share
# request][7] in the *Audit Manager User Guide*)
#
# * [DeleteAssessmentReport][8] (see also: [Deleting an assessment
# report][9] in the *Audit Manager User Guide*)
#
# * [DeleteControl][10] (see also: [Deleting a custom control][11] in
# the *Audit Manager User Guide*)
#
# At this time, Audit Manager doesn't provide an option to delete
# evidence for a specific delegated administrator. Instead, when your
# management account deregisters Audit Manager, we perform a cleanup for
# the current delegated administrator account at the time of
# deregistration.
#
#
#
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html
# [3]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html
# [4]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html
# [5]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html
# [6]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html
# [7]: https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html
# [8]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html
# [9]: https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps
# [10]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html
# [11]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html
#
# @option params [String] :admin_account_id
# The identifier for the administrator account.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.deregister_organization_admin_account({
# admin_account_id: "AccountId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount AWS API Documentation
#
# @overload deregister_organization_admin_account(params = {})
# @param [Hash] params ({})
def deregister_organization_admin_account(params = {}, options = {})
req = build_request(:deregister_organization_admin_account, params)
req.send_request(options)
end
# Disassociates an evidence folder from the specified assessment report
# in Audit Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :evidence_folder_id
# The unique identifier for the folder that the evidence is stored in.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.disassociate_assessment_report_evidence_folder({
# assessment_id: "UUID", # required
# evidence_folder_id: "UUID", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder AWS API Documentation
#
# @overload disassociate_assessment_report_evidence_folder(params = {})
# @param [Hash] params ({})
def disassociate_assessment_report_evidence_folder(params = {}, options = {})
req = build_request(:disassociate_assessment_report_evidence_folder, params)
req.send_request(options)
end
# Gets the registration status of an account in Audit Manager.
#
# @return [Types::GetAccountStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetAccountStatusResponse#status #status} => String
#
# @example Response structure
#
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING_ACTIVATION"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAccountStatus AWS API Documentation
#
# @overload get_account_status(params = {})
# @param [Hash] params ({})
def get_account_status(params = {}, options = {})
req = build_request(:get_account_status, params)
req.send_request(options)
end
# Gets information about a specified assessment.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @return [Types::GetAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetAssessmentResponse#assessment #assessment} => Types::Assessment
# * {Types::GetAssessmentResponse#user_role #user_role} => Types::Role
#
# @example Request syntax with placeholder values
#
# resp = client.get_assessment({
# assessment_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.assessment.arn #=> String
# resp.assessment.aws_account.id #=> String
# resp.assessment.aws_account.email_address #=> String
# resp.assessment.aws_account.name #=> String
# resp.assessment.metadata.name #=> String
# resp.assessment.metadata.id #=> String
# resp.assessment.metadata.description #=> String
# resp.assessment.metadata.compliance_type #=> String
# resp.assessment.metadata.status #=> String, one of "ACTIVE", "INACTIVE"
# resp.assessment.metadata.assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.assessment.metadata.assessment_reports_destination.destination #=> String
# resp.assessment.metadata.scope.aws_accounts #=> Array
# resp.assessment.metadata.scope.aws_accounts[0].id #=> String
# resp.assessment.metadata.scope.aws_accounts[0].email_address #=> String
# resp.assessment.metadata.scope.aws_accounts[0].name #=> String
# resp.assessment.metadata.scope.aws_services #=> Array
# resp.assessment.metadata.scope.aws_services[0].service_name #=> String
# resp.assessment.metadata.roles #=> Array
# resp.assessment.metadata.roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.roles[0].role_arn #=> String
# resp.assessment.metadata.delegations #=> Array
# resp.assessment.metadata.delegations[0].id #=> String
# resp.assessment.metadata.delegations[0].assessment_name #=> String
# resp.assessment.metadata.delegations[0].assessment_id #=> String
# resp.assessment.metadata.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.metadata.delegations[0].role_arn #=> String
# resp.assessment.metadata.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.delegations[0].creation_time #=> Time
# resp.assessment.metadata.delegations[0].last_updated #=> Time
# resp.assessment.metadata.delegations[0].control_set_id #=> String
# resp.assessment.metadata.delegations[0].comment #=> String
# resp.assessment.metadata.delegations[0].created_by #=> String
# resp.assessment.metadata.creation_time #=> Time
# resp.assessment.metadata.last_updated #=> Time
# resp.assessment.framework.id #=> String
# resp.assessment.framework.arn #=> String
# resp.assessment.framework.metadata.name #=> String
# resp.assessment.framework.metadata.description #=> String
# resp.assessment.framework.metadata.logo #=> String
# resp.assessment.framework.metadata.compliance_type #=> String
# resp.assessment.framework.control_sets #=> Array
# resp.assessment.framework.control_sets[0].id #=> String
# resp.assessment.framework.control_sets[0].description #=> String
# resp.assessment.framework.control_sets[0].status #=> String, one of "ACTIVE", "UNDER_REVIEW", "REVIEWED"
# resp.assessment.framework.control_sets[0].roles #=> Array
# resp.assessment.framework.control_sets[0].roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].roles[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].controls #=> Array
# resp.assessment.framework.control_sets[0].controls[0].id #=> String
# resp.assessment.framework.control_sets[0].controls[0].name #=> String
# resp.assessment.framework.control_sets[0].controls[0].description #=> String
# resp.assessment.framework.control_sets[0].controls[0].status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.assessment.framework.control_sets[0].controls[0].response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.assessment.framework.control_sets[0].controls[0].comments #=> Array
# resp.assessment.framework.control_sets[0].controls[0].comments[0].author_name #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].comment_body #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].posted_date #=> Time
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources #=> Array
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources[0] #=> String
# resp.assessment.framework.control_sets[0].controls[0].evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].controls[0].assessment_report_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].delegations #=> Array
# resp.assessment.framework.control_sets[0].delegations[0].id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_name #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.framework.control_sets[0].delegations[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].delegations[0].creation_time #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].last_updated #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].control_set_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].comment #=> String
# resp.assessment.framework.control_sets[0].delegations[0].created_by #=> String
# resp.assessment.framework.control_sets[0].system_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].manual_evidence_count #=> Integer
# resp.assessment.tags #=> Hash
# resp.assessment.tags["TagKey"] #=> String
# resp.user_role.role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.user_role.role_arn #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessment AWS API Documentation
#
# @overload get_assessment(params = {})
# @param [Hash] params ({})
def get_assessment(params = {}, options = {})
req = build_request(:get_assessment, params)
req.send_request(options)
end
# Gets information about a specified framework.
#
# @option params [required, String] :framework_id
# The identifier for the framework.
#
# @return [Types::GetAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetAssessmentFrameworkResponse#framework #framework} => Types::Framework
#
# @example Request syntax with placeholder values
#
# resp = client.get_assessment_framework({
# framework_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.framework.arn #=> String
# resp.framework.id #=> String
# resp.framework.name #=> String
# resp.framework.type #=> String, one of "Standard", "Custom"
# resp.framework.compliance_type #=> String
# resp.framework.description #=> String
# resp.framework.logo #=> String
# resp.framework.control_sources #=> String
# resp.framework.control_sets #=> Array
# resp.framework.control_sets[0].id #=> String
# resp.framework.control_sets[0].name #=> String
# resp.framework.control_sets[0].controls #=> Array
# resp.framework.control_sets[0].controls[0].arn #=> String
# resp.framework.control_sets[0].controls[0].id #=> String
# resp.framework.control_sets[0].controls[0].type #=> String, one of "Standard", "Custom", "Core"
# resp.framework.control_sets[0].controls[0].name #=> String
# resp.framework.control_sets[0].controls[0].description #=> String
# resp.framework.control_sets[0].controls[0].testing_information #=> String
# resp.framework.control_sets[0].controls[0].action_plan_title #=> String
# resp.framework.control_sets[0].controls[0].action_plan_instructions #=> String
# resp.framework.control_sets[0].controls[0].control_sources #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources #=> Array
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_id #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_name #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_description #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].troubleshooting_text #=> String
# resp.framework.control_sets[0].controls[0].created_at #=> Time
# resp.framework.control_sets[0].controls[0].last_updated_at #=> Time
# resp.framework.control_sets[0].controls[0].created_by #=> String
# resp.framework.control_sets[0].controls[0].last_updated_by #=> String
# resp.framework.control_sets[0].controls[0].tags #=> Hash
# resp.framework.control_sets[0].controls[0].tags["TagKey"] #=> String
# resp.framework.control_sets[0].controls[0].state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
# resp.framework.created_at #=> Time
# resp.framework.last_updated_at #=> Time
# resp.framework.created_by #=> String
# resp.framework.last_updated_by #=> String
# resp.framework.tags #=> Hash
# resp.framework.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentFramework AWS API Documentation
#
# @overload get_assessment_framework(params = {})
# @param [Hash] params ({})
def get_assessment_framework(params = {}, options = {})
req = build_request(:get_assessment_framework, params)
req.send_request(options)
end
# Gets the URL of an assessment report in Audit Manager.
#
# @option params [required, String] :assessment_report_id
# The unique identifier for the assessment report.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @return [Types::GetAssessmentReportUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetAssessmentReportUrlResponse#pre_signed_url #pre_signed_url} => Types::URL
#
# @example Request syntax with placeholder values
#
# resp = client.get_assessment_report_url({
# assessment_report_id: "UUID", # required
# assessment_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.pre_signed_url.hyperlink_name #=> String
# resp.pre_signed_url.link #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentReportUrl AWS API Documentation
#
# @overload get_assessment_report_url(params = {})
# @param [Hash] params ({})
def get_assessment_report_url(params = {}, options = {})
req = build_request(:get_assessment_report_url, params)
req.send_request(options)
end
# Gets a list of changelogs from Audit Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [String] :control_set_id
# The unique identifier for the control set.
#
# @option params [String] :control_id
# The unique identifier for the control.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::GetChangeLogsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetChangeLogsResponse#change_logs #change_logs} => Array<Types::ChangeLog>
# * {Types::GetChangeLogsResponse#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.get_change_logs({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId",
# control_id: "UUID",
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.change_logs #=> Array
# resp.change_logs[0].object_type #=> String, one of "ASSESSMENT", "CONTROL_SET", "CONTROL", "DELEGATION", "ASSESSMENT_REPORT"
# resp.change_logs[0].object_name #=> String
# resp.change_logs[0].action #=> String, one of "CREATE", "UPDATE_METADATA", "ACTIVE", "INACTIVE", "DELETE", "UNDER_REVIEW", "REVIEWED", "IMPORT_EVIDENCE"
# resp.change_logs[0].created_at #=> Time
# resp.change_logs[0].created_by #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetChangeLogs AWS API Documentation
#
# @overload get_change_logs(params = {})
# @param [Hash] params ({})
def get_change_logs(params = {}, options = {})
req = build_request(:get_change_logs, params)
req.send_request(options)
end
# Gets information about a specified control.
#
# @option params [required, String] :control_id
# The identifier for the control.
#
# @return [Types::GetControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetControlResponse#control #control} => Types::Control
#
# @example Request syntax with placeholder values
#
# resp = client.get_control({
# control_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.control.arn #=> String
# resp.control.id #=> String
# resp.control.type #=> String, one of "Standard", "Custom", "Core"
# resp.control.name #=> String
# resp.control.description #=> String
# resp.control.testing_information #=> String
# resp.control.action_plan_title #=> String
# resp.control.action_plan_instructions #=> String
# resp.control.control_sources #=> String
# resp.control.control_mapping_sources #=> Array
# resp.control.control_mapping_sources[0].source_id #=> String
# resp.control.control_mapping_sources[0].source_name #=> String
# resp.control.control_mapping_sources[0].source_description #=> String
# resp.control.control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.control.control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.control.control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.control.control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.control.control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.control.control_mapping_sources[0].troubleshooting_text #=> String
# resp.control.created_at #=> Time
# resp.control.last_updated_at #=> Time
# resp.control.created_by #=> String
# resp.control.last_updated_by #=> String
# resp.control.tags #=> Hash
# resp.control.tags["TagKey"] #=> String
# resp.control.state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetControl AWS API Documentation
#
# @overload get_control(params = {})
# @param [Hash] params ({})
def get_control(params = {}, options = {})
req = build_request(:get_control, params)
req.send_request(options)
end
# Gets a list of delegations from an audit owner to a delegate.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::GetDelegationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetDelegationsResponse#delegations #delegations} => Array<Types::DelegationMetadata>
# * {Types::GetDelegationsResponse#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.get_delegations({
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.delegations #=> Array
# resp.delegations[0].id #=> String
# resp.delegations[0].assessment_name #=> String
# resp.delegations[0].assessment_id #=> String
# resp.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.delegations[0].role_arn #=> String
# resp.delegations[0].creation_time #=> Time
# resp.delegations[0].control_set_name #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetDelegations AWS API Documentation
#
# @overload get_delegations(params = {})
# @param [Hash] params ({})
def get_delegations(params = {}, options = {})
req = build_request(:get_delegations, params)
req.send_request(options)
end
# Gets information about a specified evidence item.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The unique identifier for the control set.
#
# @option params [required, String] :evidence_folder_id
# The unique identifier for the folder that the evidence is stored in.
#
# @option params [required, String] :evidence_id
# The unique identifier for the evidence.
#
# @return [Types::GetEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceResponse#evidence #evidence} => Types::Evidence
#
# @example Request syntax with placeholder values
#
# resp = client.get_evidence({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# evidence_folder_id: "UUID", # required
# evidence_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.evidence.data_source #=> String
# resp.evidence.evidence_aws_account_id #=> String
# resp.evidence.time #=> Time
# resp.evidence.event_source #=> String
# resp.evidence.event_name #=> String
# resp.evidence.evidence_by_type #=> String
# resp.evidence.resources_included #=> Array
# resp.evidence.resources_included[0].arn #=> String
# resp.evidence.resources_included[0].value #=> String
# resp.evidence.resources_included[0].compliance_check #=> String
# resp.evidence.attributes #=> Hash
# resp.evidence.attributes["EvidenceAttributeKey"] #=> String
# resp.evidence.iam_id #=> String
# resp.evidence.compliance_check #=> String
# resp.evidence.aws_organization #=> String
# resp.evidence.aws_account_id #=> String
# resp.evidence.evidence_folder_id #=> String
# resp.evidence.id #=> String
# resp.evidence.assessment_report_selection #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidence AWS API Documentation
#
# @overload get_evidence(params = {})
# @param [Hash] params ({})
def get_evidence(params = {}, options = {})
req = build_request(:get_evidence, params)
req.send_request(options)
end
# Gets all evidence from a specified evidence folder in Audit Manager.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The identifier for the control set.
#
# @option params [required, String] :evidence_folder_id
# The unique identifier for the folder that the evidence is stored in.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::GetEvidenceByEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceByEvidenceFolderResponse#evidence #evidence} => Array<Types::Evidence>
# * {Types::GetEvidenceByEvidenceFolderResponse#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.get_evidence_by_evidence_folder({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# evidence_folder_id: "UUID", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.evidence #=> Array
# resp.evidence[0].data_source #=> String
# resp.evidence[0].evidence_aws_account_id #=> String
# resp.evidence[0].time #=> Time
# resp.evidence[0].event_source #=> String
# resp.evidence[0].event_name #=> String
# resp.evidence[0].evidence_by_type #=> String
# resp.evidence[0].resources_included #=> Array
# resp.evidence[0].resources_included[0].arn #=> String
# resp.evidence[0].resources_included[0].value #=> String
# resp.evidence[0].resources_included[0].compliance_check #=> String
# resp.evidence[0].attributes #=> Hash
# resp.evidence[0].attributes["EvidenceAttributeKey"] #=> String
# resp.evidence[0].iam_id #=> String
# resp.evidence[0].compliance_check #=> String
# resp.evidence[0].aws_organization #=> String
# resp.evidence[0].aws_account_id #=> String
# resp.evidence[0].evidence_folder_id #=> String
# resp.evidence[0].id #=> String
# resp.evidence[0].assessment_report_selection #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder AWS API Documentation
#
# @overload get_evidence_by_evidence_folder(params = {})
# @param [Hash] params ({})
def get_evidence_by_evidence_folder(params = {}, options = {})
req = build_request(:get_evidence_by_evidence_folder, params)
req.send_request(options)
end
# Creates a presigned Amazon S3 URL that can be used to upload a file as
# manual evidence. For instructions on how to use this operation, see
# [Upload a file from your browser ][1] in the *Audit Manager User
# Guide*.
#
# The following restrictions apply to this operation:
#
# * Maximum size of an individual evidence file: 100 MB
#
# * Number of daily manual evidence uploads per control: 100
#
# * Supported file formats: See [Supported file types for manual
# evidence][2] in the *Audit Manager User Guide*
#
# For more information about Audit Manager service restrictions, see
# [Quotas and restrictions for Audit Manager][3].
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files
# [2]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files
# [3]: https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
#
# @option params [required, String] :file_name
# The file that you want to upload. For a list of supported file
# formats, see [Supported file types for manual evidence][1] in the
# *Audit Manager User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files
#
# @return [Types::GetEvidenceFileUploadUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceFileUploadUrlResponse#evidence_file_name #evidence_file_name} => String
# * {Types::GetEvidenceFileUploadUrlResponse#upload_url #upload_url} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_evidence_file_upload_url({
# file_name: "ManualEvidenceLocalFileName", # required
# })
#
# @example Response structure
#
# resp.evidence_file_name #=> String
# resp.upload_url #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFileUploadUrl AWS API Documentation
#
# @overload get_evidence_file_upload_url(params = {})
# @param [Hash] params ({})
def get_evidence_file_upload_url(params = {}, options = {})
req = build_request(:get_evidence_file_upload_url, params)
req.send_request(options)
end
# Gets an evidence folder from a specified assessment in Audit Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The unique identifier for the control set.
#
# @option params [required, String] :evidence_folder_id
# The unique identifier for the folder that the evidence is stored in.
#
# @return [Types::GetEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceFolderResponse#evidence_folder #evidence_folder} => Types::AssessmentEvidenceFolder
#
# @example Request syntax with placeholder values
#
# resp = client.get_evidence_folder({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# evidence_folder_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.evidence_folder.name #=> String
# resp.evidence_folder.date #=> Time
# resp.evidence_folder.assessment_id #=> String
# resp.evidence_folder.control_set_id #=> String
# resp.evidence_folder.control_id #=> String
# resp.evidence_folder.id #=> String
# resp.evidence_folder.data_source #=> String
# resp.evidence_folder.author #=> String
# resp.evidence_folder.total_evidence #=> Integer
# resp.evidence_folder.assessment_report_selection_count #=> Integer
# resp.evidence_folder.control_name #=> String
# resp.evidence_folder.evidence_resources_included_count #=> Integer
# resp.evidence_folder.evidence_by_type_configuration_data_count #=> Integer
# resp.evidence_folder.evidence_by_type_manual_count #=> Integer
# resp.evidence_folder.evidence_by_type_compliance_check_count #=> Integer
# resp.evidence_folder.evidence_by_type_compliance_check_issues_count #=> Integer
# resp.evidence_folder.evidence_by_type_user_activity_count #=> Integer
# resp.evidence_folder.evidence_aws_service_source_count #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFolder AWS API Documentation
#
# @overload get_evidence_folder(params = {})
# @param [Hash] params ({})
def get_evidence_folder(params = {}, options = {})
req = build_request(:get_evidence_folder, params)
req.send_request(options)
end
# Gets the evidence folders from a specified assessment in Audit
# Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::GetEvidenceFoldersByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceFoldersByAssessmentResponse#evidence_folders #evidence_folders} => Array<Types::AssessmentEvidenceFolder>
# * {Types::GetEvidenceFoldersByAssessmentResponse#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.get_evidence_folders_by_assessment({
# assessment_id: "UUID", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.evidence_folders #=> Array
# resp.evidence_folders[0].name #=> String
# resp.evidence_folders[0].date #=> Time
# resp.evidence_folders[0].assessment_id #=> String
# resp.evidence_folders[0].control_set_id #=> String
# resp.evidence_folders[0].control_id #=> String
# resp.evidence_folders[0].id #=> String
# resp.evidence_folders[0].data_source #=> String
# resp.evidence_folders[0].author #=> String
# resp.evidence_folders[0].total_evidence #=> Integer
# resp.evidence_folders[0].assessment_report_selection_count #=> Integer
# resp.evidence_folders[0].control_name #=> String
# resp.evidence_folders[0].evidence_resources_included_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_configuration_data_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_manual_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_compliance_check_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_compliance_check_issues_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_user_activity_count #=> Integer
# resp.evidence_folders[0].evidence_aws_service_source_count #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment AWS API Documentation
#
# @overload get_evidence_folders_by_assessment(params = {})
# @param [Hash] params ({})
def get_evidence_folders_by_assessment(params = {}, options = {})
req = build_request(:get_evidence_folders_by_assessment, params)
req.send_request(options)
end
# Gets a list of evidence folders that are associated with a specified
# control in an Audit Manager assessment.
#
# @option params [required, String] :assessment_id
# The identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The identifier for the control set.
#
# @option params [required, String] :control_id
# The identifier for the control.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::GetEvidenceFoldersByAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetEvidenceFoldersByAssessmentControlResponse#evidence_folders #evidence_folders} => Array<Types::AssessmentEvidenceFolder>
# * {Types::GetEvidenceFoldersByAssessmentControlResponse#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.get_evidence_folders_by_assessment_control({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# control_id: "UUID", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.evidence_folders #=> Array
# resp.evidence_folders[0].name #=> String
# resp.evidence_folders[0].date #=> Time
# resp.evidence_folders[0].assessment_id #=> String
# resp.evidence_folders[0].control_set_id #=> String
# resp.evidence_folders[0].control_id #=> String
# resp.evidence_folders[0].id #=> String
# resp.evidence_folders[0].data_source #=> String
# resp.evidence_folders[0].author #=> String
# resp.evidence_folders[0].total_evidence #=> Integer
# resp.evidence_folders[0].assessment_report_selection_count #=> Integer
# resp.evidence_folders[0].control_name #=> String
# resp.evidence_folders[0].evidence_resources_included_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_configuration_data_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_manual_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_compliance_check_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_compliance_check_issues_count #=> Integer
# resp.evidence_folders[0].evidence_by_type_user_activity_count #=> Integer
# resp.evidence_folders[0].evidence_aws_service_source_count #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl AWS API Documentation
#
# @overload get_evidence_folders_by_assessment_control(params = {})
# @param [Hash] params ({})
def get_evidence_folders_by_assessment_control(params = {}, options = {})
req = build_request(:get_evidence_folders_by_assessment_control, params)
req.send_request(options)
end
# Gets the latest analytics data for all your current active
# assessments.
#
# @return [Types::GetInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetInsightsResponse#insights #insights} => Types::Insights
#
# @example Response structure
#
# resp.insights.active_assessments_count #=> Integer
# resp.insights.noncompliant_evidence_count #=> Integer
# resp.insights.compliant_evidence_count #=> Integer
# resp.insights.inconclusive_evidence_count #=> Integer
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
# resp.insights.total_assessment_controls_count #=> Integer
# resp.insights.last_updated #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights AWS API Documentation
#
# @overload get_insights(params = {})
# @param [Hash] params ({})
def get_insights(params = {}, options = {})
req = build_request(:get_insights, params)
req.send_request(options)
end
# Gets the latest analytics data for a specific active assessment.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @return [Types::GetInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetInsightsByAssessmentResponse#insights #insights} => Types::InsightsByAssessment
#
# @example Request syntax with placeholder values
#
# resp = client.get_insights_by_assessment({
# assessment_id: "UUID", # required
# })
#
# @example Response structure
#
# resp.insights.noncompliant_evidence_count #=> Integer
# resp.insights.compliant_evidence_count #=> Integer
# resp.insights.inconclusive_evidence_count #=> Integer
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
# resp.insights.total_assessment_controls_count #=> Integer
# resp.insights.last_updated #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment AWS API Documentation
#
# @overload get_insights_by_assessment(params = {})
# @param [Hash] params ({})
def get_insights_by_assessment(params = {}, options = {})
req = build_request(:get_insights_by_assessment, params)
req.send_request(options)
end
# Gets the name of the delegated Amazon Web Services administrator
# account for a specified organization.
#
# @return [Types::GetOrganizationAdminAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetOrganizationAdminAccountResponse#admin_account_id #admin_account_id} => String
# * {Types::GetOrganizationAdminAccountResponse#organization_id #organization_id} => String
#
# @example Response structure
#
# resp.admin_account_id #=> String
# resp.organization_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetOrganizationAdminAccount AWS API Documentation
#
# @overload get_organization_admin_account(params = {})
# @param [Hash] params ({})
def get_organization_admin_account(params = {}, options = {})
req = build_request(:get_organization_admin_account, params)
req.send_request(options)
end
# Gets a list of the Amazon Web Services from which Audit Manager can
# collect evidence.
#
# Audit Manager defines which Amazon Web Services are in scope for an
# assessment. Audit Manager infers this scope by examining the
# assessment’s controls and their data sources, and then mapping this
# information to one or more of the corresponding Amazon Web Services
# that are in this list.
#
# <note markdown="1"> For information about why it's no longer possible to specify services
# in scope manually, see [I can't edit the services in scope for my
# assessment][1] in the *Troubleshooting* section of the Audit Manager
# user guide.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-collection-issues.html#unable-to-edit-services
#
# @return [Types::GetServicesInScopeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetServicesInScopeResponse#service_metadata #service_metadata} => Array<Types::ServiceMetadata>
#
# @example Response structure
#
# resp.service_metadata #=> Array
# resp.service_metadata[0].name #=> String
# resp.service_metadata[0].display_name #=> String
# resp.service_metadata[0].description #=> String
# resp.service_metadata[0].category #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetServicesInScope AWS API Documentation
#
# @overload get_services_in_scope(params = {})
# @param [Hash] params ({})
def get_services_in_scope(params = {}, options = {})
req = build_request(:get_services_in_scope, params)
req.send_request(options)
end
# Gets the settings for a specified Amazon Web Services account.
#
# @option params [required, String] :attribute
# The list of setting attribute enum values.
#
# @return [Types::GetSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetSettingsResponse#settings #settings} => Types::Settings
#
# @example Request syntax with placeholder values
#
# resp = client.get_settings({
# attribute: "ALL", # required, accepts ALL, IS_AWS_ORG_ENABLED, SNS_TOPIC, DEFAULT_ASSESSMENT_REPORTS_DESTINATION, DEFAULT_PROCESS_OWNERS, EVIDENCE_FINDER_ENABLEMENT, DEREGISTRATION_POLICY, DEFAULT_EXPORT_DESTINATION
# })
#
# @example Response structure
#
# resp.settings.is_aws_org_enabled #=> Boolean
# resp.settings.sns_topic #=> String
# resp.settings.default_assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.settings.default_assessment_reports_destination.destination #=> String
# resp.settings.default_process_owners #=> Array
# resp.settings.default_process_owners[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.settings.default_process_owners[0].role_arn #=> String
# resp.settings.kms_key #=> String
# resp.settings.evidence_finder_enablement.event_data_store_arn #=> String
# resp.settings.evidence_finder_enablement.enablement_status #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS"
# resp.settings.evidence_finder_enablement.backfill_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
# resp.settings.evidence_finder_enablement.error #=> String
# resp.settings.deregistration_policy.delete_resources #=> String, one of "ALL", "DEFAULT"
# resp.settings.default_export_destination.destination_type #=> String, one of "S3"
# resp.settings.default_export_destination.destination #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetSettings AWS API Documentation
#
# @overload get_settings(params = {})
# @param [Hash] params ({})
def get_settings(params = {}, options = {})
req = build_request(:get_settings, params)
req.send_request(options)
end
# Lists the latest analytics data for controls within a specific control
# domain and a specific active assessment.
#
# <note markdown="1"> Control insights are listed only if the control belongs to the control
# domain and assessment that was specified. Moreover, the control must
# have collected evidence on the `lastUpdated` date of
# `controlInsightsByAssessment`. If neither of these conditions are met,
# no data is listed for that control.
#
# </note>
#
# @option params [required, String] :control_domain_id
# The unique identifier for the control domain.
#
# Audit Manager supports the control domains that are provided by Amazon
# Web Services Control Catalog. For information about how to find a list
# of available control domains, see [ `ListDomains` ][1] in the Amazon
# Web Services Control Catalog API Reference.
#
#
#
# [1]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
#
# @option params [required, String] :assessment_id
# The unique identifier for the active assessment.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListAssessmentControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#control_insights_by_assessment #control_insights_by_assessment} => Array<Types::ControlInsightsMetadataByAssessmentItem>
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#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_assessment_control_insights_by_control_domain({
# control_domain_id: "ControlDomainId", # required
# assessment_id: "UUID", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.control_insights_by_assessment #=> Array
# resp.control_insights_by_assessment[0].name #=> String
# resp.control_insights_by_assessment[0].id #=> String
# resp.control_insights_by_assessment[0].evidence_insights.noncompliant_evidence_count #=> Integer
# resp.control_insights_by_assessment[0].evidence_insights.compliant_evidence_count #=> Integer
# resp.control_insights_by_assessment[0].evidence_insights.inconclusive_evidence_count #=> Integer
# resp.control_insights_by_assessment[0].control_set_name #=> String
# resp.control_insights_by_assessment[0].last_updated #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain AWS API Documentation
#
# @overload list_assessment_control_insights_by_control_domain(params = {})
# @param [Hash] params ({})
def list_assessment_control_insights_by_control_domain(params = {}, options = {})
req = build_request(:list_assessment_control_insights_by_control_domain, params)
req.send_request(options)
end
# Returns a list of sent or received share requests for custom
# frameworks in Audit Manager.
#
# @option params [required, String] :request_type
# Specifies whether the share request is a sent request or a received
# request.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListAssessmentFrameworkShareRequestsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListAssessmentFrameworkShareRequestsResponse#assessment_framework_share_requests #assessment_framework_share_requests} => Array<Types::AssessmentFrameworkShareRequest>
# * {Types::ListAssessmentFrameworkShareRequestsResponse#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_assessment_framework_share_requests({
# request_type: "SENT", # required, accepts SENT, RECEIVED
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.assessment_framework_share_requests #=> Array
# resp.assessment_framework_share_requests[0].id #=> String
# resp.assessment_framework_share_requests[0].framework_id #=> String
# resp.assessment_framework_share_requests[0].framework_name #=> String
# resp.assessment_framework_share_requests[0].framework_description #=> String
# resp.assessment_framework_share_requests[0].status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
# resp.assessment_framework_share_requests[0].source_account #=> String
# resp.assessment_framework_share_requests[0].destination_account #=> String
# resp.assessment_framework_share_requests[0].destination_region #=> String
# resp.assessment_framework_share_requests[0].expiration_time #=> Time
# resp.assessment_framework_share_requests[0].creation_time #=> Time
# resp.assessment_framework_share_requests[0].last_updated #=> Time
# resp.assessment_framework_share_requests[0].comment #=> String
# resp.assessment_framework_share_requests[0].standard_controls_count #=> Integer
# resp.assessment_framework_share_requests[0].custom_controls_count #=> Integer
# resp.assessment_framework_share_requests[0].compliance_type #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests AWS API Documentation
#
# @overload list_assessment_framework_share_requests(params = {})
# @param [Hash] params ({})
def list_assessment_framework_share_requests(params = {}, options = {})
req = build_request(:list_assessment_framework_share_requests, params)
req.send_request(options)
end
# Returns a list of the frameworks that are available in the Audit
# Manager framework library.
#
# @option params [required, String] :framework_type
# The type of framework, such as a standard framework or a custom
# framework.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListAssessmentFrameworksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListAssessmentFrameworksResponse#framework_metadata_list #framework_metadata_list} => Array<Types::AssessmentFrameworkMetadata>
# * {Types::ListAssessmentFrameworksResponse#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_assessment_frameworks({
# framework_type: "Standard", # required, accepts Standard, Custom
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.framework_metadata_list #=> Array
# resp.framework_metadata_list[0].arn #=> String
# resp.framework_metadata_list[0].id #=> String
# resp.framework_metadata_list[0].type #=> String, one of "Standard", "Custom"
# resp.framework_metadata_list[0].name #=> String
# resp.framework_metadata_list[0].description #=> String
# resp.framework_metadata_list[0].logo #=> String
# resp.framework_metadata_list[0].compliance_type #=> String
# resp.framework_metadata_list[0].controls_count #=> Integer
# resp.framework_metadata_list[0].control_sets_count #=> Integer
# resp.framework_metadata_list[0].created_at #=> Time
# resp.framework_metadata_list[0].last_updated_at #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworks AWS API Documentation
#
# @overload list_assessment_frameworks(params = {})
# @param [Hash] params ({})
def list_assessment_frameworks(params = {}, options = {})
req = build_request(:list_assessment_frameworks, params)
req.send_request(options)
end
# Returns a list of assessment reports created in Audit Manager.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListAssessmentReportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListAssessmentReportsResponse#assessment_reports #assessment_reports} => Array<Types::AssessmentReportMetadata>
# * {Types::ListAssessmentReportsResponse#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_assessment_reports({
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.assessment_reports #=> Array
# resp.assessment_reports[0].id #=> String
# resp.assessment_reports[0].name #=> String
# resp.assessment_reports[0].description #=> String
# resp.assessment_reports[0].assessment_id #=> String
# resp.assessment_reports[0].assessment_name #=> String
# resp.assessment_reports[0].author #=> String
# resp.assessment_reports[0].status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
# resp.assessment_reports[0].creation_time #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentReports AWS API Documentation
#
# @overload list_assessment_reports(params = {})
# @param [Hash] params ({})
def list_assessment_reports(params = {}, options = {})
req = build_request(:list_assessment_reports, params)
req.send_request(options)
end
# Returns a list of current and past assessments from Audit Manager.
#
# @option params [String] :status
# The current status of the assessment.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListAssessmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListAssessmentsResponse#assessment_metadata #assessment_metadata} => Array<Types::AssessmentMetadataItem>
# * {Types::ListAssessmentsResponse#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_assessments({
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.assessment_metadata #=> Array
# resp.assessment_metadata[0].name #=> String
# resp.assessment_metadata[0].id #=> String
# resp.assessment_metadata[0].compliance_type #=> String
# resp.assessment_metadata[0].status #=> String, one of "ACTIVE", "INACTIVE"
# resp.assessment_metadata[0].roles #=> Array
# resp.assessment_metadata[0].roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment_metadata[0].roles[0].role_arn #=> String
# resp.assessment_metadata[0].delegations #=> Array
# resp.assessment_metadata[0].delegations[0].id #=> String
# resp.assessment_metadata[0].delegations[0].assessment_name #=> String
# resp.assessment_metadata[0].delegations[0].assessment_id #=> String
# resp.assessment_metadata[0].delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment_metadata[0].delegations[0].role_arn #=> String
# resp.assessment_metadata[0].delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment_metadata[0].delegations[0].creation_time #=> Time
# resp.assessment_metadata[0].delegations[0].last_updated #=> Time
# resp.assessment_metadata[0].delegations[0].control_set_id #=> String
# resp.assessment_metadata[0].delegations[0].comment #=> String
# resp.assessment_metadata[0].delegations[0].created_by #=> String
# resp.assessment_metadata[0].creation_time #=> Time
# resp.assessment_metadata[0].last_updated #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessments AWS API Documentation
#
# @overload list_assessments(params = {})
# @param [Hash] params ({})
def list_assessments(params = {}, options = {})
req = build_request(:list_assessments, params)
req.send_request(options)
end
# Lists the latest analytics data for control domains across all of your
# active assessments.
#
# Audit Manager supports the control domains that are provided by Amazon
# Web Services Control Catalog. For information about how to find a list
# of available control domains, see [ `ListDomains` ][1] in the Amazon
# Web Services Control Catalog API Reference.
#
# <note markdown="1"> A control domain is listed only if at least one of the controls within
# that domain collected evidence on the `lastUpdated` date of
# `controlDomainInsights`. If this condition isn’t met, no data is
# listed for that control domain.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListControlDomainInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListControlDomainInsightsResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
# * {Types::ListControlDomainInsightsResponse#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_control_domain_insights({
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.control_domain_insights #=> Array
# resp.control_domain_insights[0].name #=> String
# resp.control_domain_insights[0].id #=> String
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
# resp.control_domain_insights[0].total_controls_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
# resp.control_domain_insights[0].last_updated #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights AWS API Documentation
#
# @overload list_control_domain_insights(params = {})
# @param [Hash] params ({})
def list_control_domain_insights(params = {}, options = {})
req = build_request(:list_control_domain_insights, params)
req.send_request(options)
end
# Lists analytics data for control domains within a specified active
# assessment.
#
# Audit Manager supports the control domains that are provided by Amazon
# Web Services Control Catalog. For information about how to find a list
# of available control domains, see [ `ListDomains` ][1] in the Amazon
# Web Services Control Catalog API Reference.
#
# <note markdown="1"> A control domain is listed only if at least one of the controls within
# that domain collected evidence on the `lastUpdated` date of
# `controlDomainInsights`. If this condition isn’t met, no data is
# listed for that domain.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
#
# @option params [required, String] :assessment_id
# The unique identifier for the active assessment.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListControlDomainInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListControlDomainInsightsByAssessmentResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
# * {Types::ListControlDomainInsightsByAssessmentResponse#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_control_domain_insights_by_assessment({
# assessment_id: "UUID", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.control_domain_insights #=> Array
# resp.control_domain_insights[0].name #=> String
# resp.control_domain_insights[0].id #=> String
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
# resp.control_domain_insights[0].total_controls_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
# resp.control_domain_insights[0].last_updated #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment AWS API Documentation
#
# @overload list_control_domain_insights_by_assessment(params = {})
# @param [Hash] params ({})
def list_control_domain_insights_by_assessment(params = {}, options = {})
req = build_request(:list_control_domain_insights_by_assessment, params)
req.send_request(options)
end
# Lists the latest analytics data for controls within a specific control
# domain across all active assessments.
#
# <note markdown="1"> Control insights are listed only if the control belongs to the control
# domain that was specified and the control collected evidence on the
# `lastUpdated` date of `controlInsightsMetadata`. If neither of these
# conditions are met, no data is listed for that control.
#
# </note>
#
# @option params [required, String] :control_domain_id
# The unique identifier for the control domain.
#
# Audit Manager supports the control domains that are provided by Amazon
# Web Services Control Catalog. For information about how to find a list
# of available control domains, see [ `ListDomains` ][1] in the Amazon
# Web Services Control Catalog API Reference.
#
#
#
# [1]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListControlInsightsByControlDomainResponse#control_insights_metadata #control_insights_metadata} => Array<Types::ControlInsightsMetadataItem>
# * {Types::ListControlInsightsByControlDomainResponse#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_control_insights_by_control_domain({
# control_domain_id: "ControlDomainId", # required
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.control_insights_metadata #=> Array
# resp.control_insights_metadata[0].name #=> String
# resp.control_insights_metadata[0].id #=> String
# resp.control_insights_metadata[0].evidence_insights.noncompliant_evidence_count #=> Integer
# resp.control_insights_metadata[0].evidence_insights.compliant_evidence_count #=> Integer
# resp.control_insights_metadata[0].evidence_insights.inconclusive_evidence_count #=> Integer
# resp.control_insights_metadata[0].last_updated #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain AWS API Documentation
#
# @overload list_control_insights_by_control_domain(params = {})
# @param [Hash] params ({})
def list_control_insights_by_control_domain(params = {}, options = {})
req = build_request(:list_control_insights_by_control_domain, params)
req.send_request(options)
end
# Returns a list of controls from Audit Manager.
#
# @option params [required, String] :control_type
# A filter that narrows the list of controls to a specific type.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# The maximum number of results on a page or for an API request call.
#
# @option params [String] :control_catalog_id
# A filter that narrows the list of controls to a specific resource from
# the Amazon Web Services Control Catalog.
#
# To use this parameter, specify the ARN of the Control Catalog
# resource. You can specify either a control domain, a control
# objective, or a common control. For information about how to find the
# ARNs for these resources, see [ `ListDomains` ][1], [ `ListObjectives`
# ][2], and [ `ListCommonControls` ][3].
#
# <note markdown="1"> You can only filter by one Control Catalog resource at a time.
# Specifying multiple resource ARNs isn’t currently supported. If you
# want to filter by more than one ARN, we recommend that you run the
# `ListControls` operation separately for each ARN.
#
# </note>
#
# Alternatively, specify `UNCATEGORIZED` to list controls that aren't
# mapped to a Control Catalog resource. For example, this operation
# might return a list of custom controls that don't belong to any
# control domain or control objective.
#
#
#
# [1]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
# [2]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListObjectives.html
# [3]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListCommonControls.html
#
# @return [Types::ListControlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListControlsResponse#control_metadata_list #control_metadata_list} => Array<Types::ControlMetadata>
# * {Types::ListControlsResponse#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_controls({
# control_type: "Standard", # required, accepts Standard, Custom, Core
# next_token: "Token",
# max_results: 1,
# control_catalog_id: "ControlCatalogId",
# })
#
# @example Response structure
#
# resp.control_metadata_list #=> Array
# resp.control_metadata_list[0].arn #=> String
# resp.control_metadata_list[0].id #=> String
# resp.control_metadata_list[0].name #=> String
# resp.control_metadata_list[0].control_sources #=> String
# resp.control_metadata_list[0].created_at #=> Time
# resp.control_metadata_list[0].last_updated_at #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls AWS API Documentation
#
# @overload list_controls(params = {})
# @param [Hash] params ({})
def list_controls(params = {}, options = {})
req = build_request(:list_controls, params)
req.send_request(options)
end
# Returns a list of keywords that are pre-mapped to the specified
# control data source.
#
# @option params [required, String] :source
# The control mapping data source that the keywords apply to.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListKeywordsForDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListKeywordsForDataSourceResponse#keywords #keywords} => Array<String>
# * {Types::ListKeywordsForDataSourceResponse#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_keywords_for_data_source({
# source: "AWS_Cloudtrail", # required, accepts AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, MANUAL
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.keywords #=> Array
# resp.keywords[0] #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource AWS API Documentation
#
# @overload list_keywords_for_data_source(params = {})
# @param [Hash] params ({})
def list_keywords_for_data_source(params = {}, options = {})
req = build_request(:list_keywords_for_data_source, params)
req.send_request(options)
end
# Returns a list of all Audit Manager notifications.
#
# @option params [String] :next_token
# The pagination token that's used to fetch the next set of results.
#
# @option params [Integer] :max_results
# Represents the maximum number of results on a page or for an API
# request call.
#
# @return [Types::ListNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListNotificationsResponse#notifications #notifications} => Array<Types::Notification>
# * {Types::ListNotificationsResponse#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_notifications({
# next_token: "Token",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.notifications #=> Array
# resp.notifications[0].id #=> String
# resp.notifications[0].assessment_id #=> String
# resp.notifications[0].assessment_name #=> String
# resp.notifications[0].control_set_id #=> String
# resp.notifications[0].control_set_name #=> String
# resp.notifications[0].description #=> String
# resp.notifications[0].event_time #=> Time
# resp.notifications[0].source #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications AWS API Documentation
#
# @overload list_notifications(params = {})
# @param [Hash] params ({})
def list_notifications(params = {}, options = {})
req = build_request(:list_notifications, params)
req.send_request(options)
end
# Returns a list of tags for the specified resource in Audit Manager.
#
# @option params [required, String] :resource_arn
# The Amazon Resource Name (ARN) of the resource.
#
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.list_tags_for_resource({
# resource_arn: "AuditManagerArn", # required
# })
#
# @example Response structure
#
# resp.tags #=> Hash
# resp.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource AWS API Documentation
#
# @overload list_tags_for_resource(params = {})
# @param [Hash] params ({})
def list_tags_for_resource(params = {}, options = {})
req = build_request(:list_tags_for_resource, params)
req.send_request(options)
end
# Enables Audit Manager for the specified Amazon Web Services account.
#
# @option params [String] :kms_key
# The KMS key details.
#
# @option params [String] :delegated_admin_account
# The delegated administrator account for Audit Manager.
#
# @return [Types::RegisterAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterAccountResponse#status #status} => String
#
# @example Request syntax with placeholder values
#
# resp = client.register_account({
# kms_key: "KmsKey",
# delegated_admin_account: "AccountId",
# })
#
# @example Response structure
#
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING_ACTIVATION"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount AWS API Documentation
#
# @overload register_account(params = {})
# @param [Hash] params ({})
def register_account(params = {}, options = {})
req = build_request(:register_account, params)
req.send_request(options)
end
# Enables an Amazon Web Services account within the organization as the
# delegated administrator for Audit Manager.
#
# @option params [required, String] :admin_account_id
# The identifier for the delegated administrator account.
#
# @return [Types::RegisterOrganizationAdminAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterOrganizationAdminAccountResponse#admin_account_id #admin_account_id} => String
# * {Types::RegisterOrganizationAdminAccountResponse#organization_id #organization_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.register_organization_admin_account({
# admin_account_id: "AccountId", # required
# })
#
# @example Response structure
#
# resp.admin_account_id #=> String
# resp.organization_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount AWS API Documentation
#
# @overload register_organization_admin_account(params = {})
# @param [Hash] params ({})
def register_organization_admin_account(params = {}, options = {})
req = build_request(:register_organization_admin_account, params)
req.send_request(options)
end
# Creates a share request for a custom framework in Audit Manager.
#
# The share request specifies a recipient and notifies them that a
# custom framework is available. Recipients have 120 days to accept or
# decline the request. If no action is taken, the share request expires.
#
# When you create a share request, Audit Manager stores a snapshot of
# your custom framework in the US East (N. Virginia) Amazon Web Services
# Region. Audit Manager also stores a backup of the same snapshot in the
# US West (Oregon) Amazon Web Services Region.
#
# Audit Manager deletes the snapshot and the backup snapshot when one of
# the following events occurs:
#
# * The sender revokes the share request.
#
# * The recipient declines the share request.
#
# * The recipient encounters an error and doesn't successfully accept
# the share request.
#
# * The share request expires before the recipient responds to the
# request.
#
# When a sender [resends a share request][1], the snapshot is replaced
# with an updated version that corresponds with the latest version of
# the custom framework.
#
# When a recipient accepts a share request, the snapshot is replicated
# into their Amazon Web Services account under the Amazon Web Services
# Region that was specified in the share request.
#
# When you invoke the `StartAssessmentFrameworkShare` API, you are about
# to share a custom framework with another Amazon Web Services account.
# You may not share a custom framework that is derived from a standard
# framework if the standard framework is designated as not eligible for
# sharing by Amazon Web Services, unless you have obtained permission to
# do so from the owner of the standard framework. To learn more about
# which standard frameworks are eligible for sharing, see [Framework
# sharing eligibility][2] in the *Audit Manager User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend
# [2]: https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility
#
# @option params [required, String] :framework_id
# The unique identifier for the custom framework to be shared.
#
# @option params [required, String] :destination_account
# The Amazon Web Services account of the recipient.
#
# @option params [required, String] :destination_region
# The Amazon Web Services Region of the recipient.
#
# @option params [String] :comment
# An optional comment from the sender about the share request.
#
# @return [Types::StartAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StartAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
#
# @example Request syntax with placeholder values
#
# resp = client.start_assessment_framework_share({
# framework_id: "UUID", # required
# destination_account: "AccountId", # required
# destination_region: "Region", # required
# comment: "ShareRequestComment",
# })
#
# @example Response structure
#
# resp.assessment_framework_share_request.id #=> String
# resp.assessment_framework_share_request.framework_id #=> String
# resp.assessment_framework_share_request.framework_name #=> String
# resp.assessment_framework_share_request.framework_description #=> String
# resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
# resp.assessment_framework_share_request.source_account #=> String
# resp.assessment_framework_share_request.destination_account #=> String
# resp.assessment_framework_share_request.destination_region #=> String
# resp.assessment_framework_share_request.expiration_time #=> Time
# resp.assessment_framework_share_request.creation_time #=> Time
# resp.assessment_framework_share_request.last_updated #=> Time
# resp.assessment_framework_share_request.comment #=> String
# resp.assessment_framework_share_request.standard_controls_count #=> Integer
# resp.assessment_framework_share_request.custom_controls_count #=> Integer
# resp.assessment_framework_share_request.compliance_type #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare AWS API Documentation
#
# @overload start_assessment_framework_share(params = {})
# @param [Hash] params ({})
def start_assessment_framework_share(params = {}, options = {})
req = build_request(:start_assessment_framework_share, params)
req.send_request(options)
end
# Tags the specified resource in Audit Manager.
#
# @option params [required, String] :resource_arn
# The Amazon Resource Name (ARN) of the resource.
#
# @option params [required, Hash<String,String>] :tags
# The tags that are associated with the resource.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.tag_resource({
# resource_arn: "AuditManagerArn", # required
# tags: { # required
# "TagKey" => "TagValue",
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/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
# Removes a tag from a resource in Audit Manager.
#
# @option params [required, String] :resource_arn
# The Amazon Resource Name (ARN) of the specified resource.
#
# @option params [required, Array<String>] :tag_keys
# The name or key of the tag.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.untag_resource({
# resource_arn: "AuditManagerArn", # required
# tag_keys: ["TagKey"], # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/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
# Edits an Audit Manager assessment.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [String] :assessment_name
# The name of the assessment to be updated.
#
# @option params [String] :assessment_description
# The description of the assessment.
#
# @option params [required, Types::Scope] :scope
# The scope of the assessment.
#
# @option params [Types::AssessmentReportsDestination] :assessment_reports_destination
# The assessment report storage destination for the assessment that's
# being updated.
#
# @option params [Array<Types::Role>] :roles
# The list of roles for the assessment.
#
# @return [Types::UpdateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentResponse#assessment #assessment} => Types::Assessment
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment({
# assessment_id: "UUID", # required
# assessment_name: "AssessmentName",
# assessment_description: "AssessmentDescription",
# scope: { # required
# aws_accounts: [
# {
# id: "AccountId",
# email_address: "EmailAddress",
# name: "AccountName",
# },
# ],
# aws_services: [
# {
# service_name: "AWSServiceName",
# },
# ],
# },
# assessment_reports_destination: {
# destination_type: "S3", # accepts S3
# destination: "S3Url",
# },
# roles: [
# {
# role_type: "PROCESS_OWNER", # required, accepts PROCESS_OWNER, RESOURCE_OWNER
# role_arn: "IamArn", # required
# },
# ],
# })
#
# @example Response structure
#
# resp.assessment.arn #=> String
# resp.assessment.aws_account.id #=> String
# resp.assessment.aws_account.email_address #=> String
# resp.assessment.aws_account.name #=> String
# resp.assessment.metadata.name #=> String
# resp.assessment.metadata.id #=> String
# resp.assessment.metadata.description #=> String
# resp.assessment.metadata.compliance_type #=> String
# resp.assessment.metadata.status #=> String, one of "ACTIVE", "INACTIVE"
# resp.assessment.metadata.assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.assessment.metadata.assessment_reports_destination.destination #=> String
# resp.assessment.metadata.scope.aws_accounts #=> Array
# resp.assessment.metadata.scope.aws_accounts[0].id #=> String
# resp.assessment.metadata.scope.aws_accounts[0].email_address #=> String
# resp.assessment.metadata.scope.aws_accounts[0].name #=> String
# resp.assessment.metadata.scope.aws_services #=> Array
# resp.assessment.metadata.scope.aws_services[0].service_name #=> String
# resp.assessment.metadata.roles #=> Array
# resp.assessment.metadata.roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.roles[0].role_arn #=> String
# resp.assessment.metadata.delegations #=> Array
# resp.assessment.metadata.delegations[0].id #=> String
# resp.assessment.metadata.delegations[0].assessment_name #=> String
# resp.assessment.metadata.delegations[0].assessment_id #=> String
# resp.assessment.metadata.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.metadata.delegations[0].role_arn #=> String
# resp.assessment.metadata.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.delegations[0].creation_time #=> Time
# resp.assessment.metadata.delegations[0].last_updated #=> Time
# resp.assessment.metadata.delegations[0].control_set_id #=> String
# resp.assessment.metadata.delegations[0].comment #=> String
# resp.assessment.metadata.delegations[0].created_by #=> String
# resp.assessment.metadata.creation_time #=> Time
# resp.assessment.metadata.last_updated #=> Time
# resp.assessment.framework.id #=> String
# resp.assessment.framework.arn #=> String
# resp.assessment.framework.metadata.name #=> String
# resp.assessment.framework.metadata.description #=> String
# resp.assessment.framework.metadata.logo #=> String
# resp.assessment.framework.metadata.compliance_type #=> String
# resp.assessment.framework.control_sets #=> Array
# resp.assessment.framework.control_sets[0].id #=> String
# resp.assessment.framework.control_sets[0].description #=> String
# resp.assessment.framework.control_sets[0].status #=> String, one of "ACTIVE", "UNDER_REVIEW", "REVIEWED"
# resp.assessment.framework.control_sets[0].roles #=> Array
# resp.assessment.framework.control_sets[0].roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].roles[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].controls #=> Array
# resp.assessment.framework.control_sets[0].controls[0].id #=> String
# resp.assessment.framework.control_sets[0].controls[0].name #=> String
# resp.assessment.framework.control_sets[0].controls[0].description #=> String
# resp.assessment.framework.control_sets[0].controls[0].status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.assessment.framework.control_sets[0].controls[0].response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.assessment.framework.control_sets[0].controls[0].comments #=> Array
# resp.assessment.framework.control_sets[0].controls[0].comments[0].author_name #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].comment_body #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].posted_date #=> Time
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources #=> Array
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources[0] #=> String
# resp.assessment.framework.control_sets[0].controls[0].evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].controls[0].assessment_report_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].delegations #=> Array
# resp.assessment.framework.control_sets[0].delegations[0].id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_name #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.framework.control_sets[0].delegations[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].delegations[0].creation_time #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].last_updated #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].control_set_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].comment #=> String
# resp.assessment.framework.control_sets[0].delegations[0].created_by #=> String
# resp.assessment.framework.control_sets[0].system_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].manual_evidence_count #=> Integer
# resp.assessment.tags #=> Hash
# resp.assessment.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment AWS API Documentation
#
# @overload update_assessment(params = {})
# @param [Hash] params ({})
def update_assessment(params = {}, options = {})
req = build_request(:update_assessment, params)
req.send_request(options)
end
# Updates a control within an assessment in Audit Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The unique identifier for the control set.
#
# @option params [required, String] :control_id
# The unique identifier for the control.
#
# @option params [String] :control_status
# The status of the control.
#
# @option params [String] :comment_body
# The comment body text for the control.
#
# @return [Types::UpdateAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentControlResponse#control #control} => Types::AssessmentControl
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment_control({
# assessment_id: "UUID", # required
# control_set_id: "ControlSetId", # required
# control_id: "UUID", # required
# control_status: "UNDER_REVIEW", # accepts UNDER_REVIEW, REVIEWED, INACTIVE
# comment_body: "ControlCommentBody",
# })
#
# @example Response structure
#
# resp.control.id #=> String
# resp.control.name #=> String
# resp.control.description #=> String
# resp.control.status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.control.response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.control.comments #=> Array
# resp.control.comments[0].author_name #=> String
# resp.control.comments[0].comment_body #=> String
# resp.control.comments[0].posted_date #=> Time
# resp.control.evidence_sources #=> Array
# resp.control.evidence_sources[0] #=> String
# resp.control.evidence_count #=> Integer
# resp.control.assessment_report_evidence_count #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl AWS API Documentation
#
# @overload update_assessment_control(params = {})
# @param [Hash] params ({})
def update_assessment_control(params = {}, options = {})
req = build_request(:update_assessment_control, params)
req.send_request(options)
end
# Updates the status of a control set in an Audit Manager assessment.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :control_set_id
# The unique identifier for the control set.
#
# @option params [required, String] :status
# The status of the control set that's being updated.
#
# @option params [required, String] :comment
# The comment that's related to the status update.
#
# @return [Types::UpdateAssessmentControlSetStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentControlSetStatusResponse#control_set #control_set} => Types::AssessmentControlSet
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment_control_set_status({
# assessment_id: "UUID", # required
# control_set_id: "String", # required
# status: "ACTIVE", # required, accepts ACTIVE, UNDER_REVIEW, REVIEWED
# comment: "DelegationComment", # required
# })
#
# @example Response structure
#
# resp.control_set.id #=> String
# resp.control_set.description #=> String
# resp.control_set.status #=> String, one of "ACTIVE", "UNDER_REVIEW", "REVIEWED"
# resp.control_set.roles #=> Array
# resp.control_set.roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.control_set.roles[0].role_arn #=> String
# resp.control_set.controls #=> Array
# resp.control_set.controls[0].id #=> String
# resp.control_set.controls[0].name #=> String
# resp.control_set.controls[0].description #=> String
# resp.control_set.controls[0].status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.control_set.controls[0].response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.control_set.controls[0].comments #=> Array
# resp.control_set.controls[0].comments[0].author_name #=> String
# resp.control_set.controls[0].comments[0].comment_body #=> String
# resp.control_set.controls[0].comments[0].posted_date #=> Time
# resp.control_set.controls[0].evidence_sources #=> Array
# resp.control_set.controls[0].evidence_sources[0] #=> String
# resp.control_set.controls[0].evidence_count #=> Integer
# resp.control_set.controls[0].assessment_report_evidence_count #=> Integer
# resp.control_set.delegations #=> Array
# resp.control_set.delegations[0].id #=> String
# resp.control_set.delegations[0].assessment_name #=> String
# resp.control_set.delegations[0].assessment_id #=> String
# resp.control_set.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.control_set.delegations[0].role_arn #=> String
# resp.control_set.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.control_set.delegations[0].creation_time #=> Time
# resp.control_set.delegations[0].last_updated #=> Time
# resp.control_set.delegations[0].control_set_id #=> String
# resp.control_set.delegations[0].comment #=> String
# resp.control_set.delegations[0].created_by #=> String
# resp.control_set.system_evidence_count #=> Integer
# resp.control_set.manual_evidence_count #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus AWS API Documentation
#
# @overload update_assessment_control_set_status(params = {})
# @param [Hash] params ({})
def update_assessment_control_set_status(params = {}, options = {})
req = build_request(:update_assessment_control_set_status, params)
req.send_request(options)
end
# Updates a custom framework in Audit Manager.
#
# @option params [required, String] :framework_id
# The unique identifier for the framework.
#
# @option params [required, String] :name
# The name of the framework to be updated.
#
# @option params [String] :description
# The description of the updated framework.
#
# @option params [String] :compliance_type
# The compliance type that the new custom framework supports, such as
# CIS or HIPAA.
#
# @option params [required, Array<Types::UpdateAssessmentFrameworkControlSet>] :control_sets
# The control sets that are associated with the framework.
#
# @return [Types::UpdateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentFrameworkResponse#framework #framework} => Types::Framework
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment_framework({
# framework_id: "UUID", # required
# name: "FrameworkName", # required
# description: "FrameworkDescription",
# compliance_type: "ComplianceType",
# control_sets: [ # required
# {
# id: "ControlSetName",
# name: "ControlSetName", # required
# controls: [ # required
# {
# id: "UUID", # required
# },
# ],
# },
# ],
# })
#
# @example Response structure
#
# resp.framework.arn #=> String
# resp.framework.id #=> String
# resp.framework.name #=> String
# resp.framework.type #=> String, one of "Standard", "Custom"
# resp.framework.compliance_type #=> String
# resp.framework.description #=> String
# resp.framework.logo #=> String
# resp.framework.control_sources #=> String
# resp.framework.control_sets #=> Array
# resp.framework.control_sets[0].id #=> String
# resp.framework.control_sets[0].name #=> String
# resp.framework.control_sets[0].controls #=> Array
# resp.framework.control_sets[0].controls[0].arn #=> String
# resp.framework.control_sets[0].controls[0].id #=> String
# resp.framework.control_sets[0].controls[0].type #=> String, one of "Standard", "Custom", "Core"
# resp.framework.control_sets[0].controls[0].name #=> String
# resp.framework.control_sets[0].controls[0].description #=> String
# resp.framework.control_sets[0].controls[0].testing_information #=> String
# resp.framework.control_sets[0].controls[0].action_plan_title #=> String
# resp.framework.control_sets[0].controls[0].action_plan_instructions #=> String
# resp.framework.control_sets[0].controls[0].control_sources #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources #=> Array
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_id #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_name #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_description #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.framework.control_sets[0].controls[0].control_mapping_sources[0].troubleshooting_text #=> String
# resp.framework.control_sets[0].controls[0].created_at #=> Time
# resp.framework.control_sets[0].controls[0].last_updated_at #=> Time
# resp.framework.control_sets[0].controls[0].created_by #=> String
# resp.framework.control_sets[0].controls[0].last_updated_by #=> String
# resp.framework.control_sets[0].controls[0].tags #=> Hash
# resp.framework.control_sets[0].controls[0].tags["TagKey"] #=> String
# resp.framework.control_sets[0].controls[0].state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
# resp.framework.created_at #=> Time
# resp.framework.last_updated_at #=> Time
# resp.framework.created_by #=> String
# resp.framework.last_updated_by #=> String
# resp.framework.tags #=> Hash
# resp.framework.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework AWS API Documentation
#
# @overload update_assessment_framework(params = {})
# @param [Hash] params ({})
def update_assessment_framework(params = {}, options = {})
req = build_request(:update_assessment_framework, params)
req.send_request(options)
end
# Updates a share request for a custom framework in Audit Manager.
#
# @option params [required, String] :request_id
# The unique identifier for the share request.
#
# @option params [required, String] :request_type
# Specifies whether the share request is a sent request or a received
# request.
#
# @option params [required, String] :action
# Specifies the update action for the share request.
#
# @return [Types::UpdateAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment_framework_share({
# request_id: "UUID", # required
# request_type: "SENT", # required, accepts SENT, RECEIVED
# action: "ACCEPT", # required, accepts ACCEPT, DECLINE, REVOKE
# })
#
# @example Response structure
#
# resp.assessment_framework_share_request.id #=> String
# resp.assessment_framework_share_request.framework_id #=> String
# resp.assessment_framework_share_request.framework_name #=> String
# resp.assessment_framework_share_request.framework_description #=> String
# resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
# resp.assessment_framework_share_request.source_account #=> String
# resp.assessment_framework_share_request.destination_account #=> String
# resp.assessment_framework_share_request.destination_region #=> String
# resp.assessment_framework_share_request.expiration_time #=> Time
# resp.assessment_framework_share_request.creation_time #=> Time
# resp.assessment_framework_share_request.last_updated #=> Time
# resp.assessment_framework_share_request.comment #=> String
# resp.assessment_framework_share_request.standard_controls_count #=> Integer
# resp.assessment_framework_share_request.custom_controls_count #=> Integer
# resp.assessment_framework_share_request.compliance_type #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare AWS API Documentation
#
# @overload update_assessment_framework_share(params = {})
# @param [Hash] params ({})
def update_assessment_framework_share(params = {}, options = {})
req = build_request(:update_assessment_framework_share, params)
req.send_request(options)
end
# Updates the status of an assessment in Audit Manager.
#
# @option params [required, String] :assessment_id
# The unique identifier for the assessment.
#
# @option params [required, String] :status
# The current status of the assessment.
#
# @return [Types::UpdateAssessmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAssessmentStatusResponse#assessment #assessment} => Types::Assessment
#
# @example Request syntax with placeholder values
#
# resp = client.update_assessment_status({
# assessment_id: "UUID", # required
# status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
# })
#
# @example Response structure
#
# resp.assessment.arn #=> String
# resp.assessment.aws_account.id #=> String
# resp.assessment.aws_account.email_address #=> String
# resp.assessment.aws_account.name #=> String
# resp.assessment.metadata.name #=> String
# resp.assessment.metadata.id #=> String
# resp.assessment.metadata.description #=> String
# resp.assessment.metadata.compliance_type #=> String
# resp.assessment.metadata.status #=> String, one of "ACTIVE", "INACTIVE"
# resp.assessment.metadata.assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.assessment.metadata.assessment_reports_destination.destination #=> String
# resp.assessment.metadata.scope.aws_accounts #=> Array
# resp.assessment.metadata.scope.aws_accounts[0].id #=> String
# resp.assessment.metadata.scope.aws_accounts[0].email_address #=> String
# resp.assessment.metadata.scope.aws_accounts[0].name #=> String
# resp.assessment.metadata.scope.aws_services #=> Array
# resp.assessment.metadata.scope.aws_services[0].service_name #=> String
# resp.assessment.metadata.roles #=> Array
# resp.assessment.metadata.roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.roles[0].role_arn #=> String
# resp.assessment.metadata.delegations #=> Array
# resp.assessment.metadata.delegations[0].id #=> String
# resp.assessment.metadata.delegations[0].assessment_name #=> String
# resp.assessment.metadata.delegations[0].assessment_id #=> String
# resp.assessment.metadata.delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.metadata.delegations[0].role_arn #=> String
# resp.assessment.metadata.delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.metadata.delegations[0].creation_time #=> Time
# resp.assessment.metadata.delegations[0].last_updated #=> Time
# resp.assessment.metadata.delegations[0].control_set_id #=> String
# resp.assessment.metadata.delegations[0].comment #=> String
# resp.assessment.metadata.delegations[0].created_by #=> String
# resp.assessment.metadata.creation_time #=> Time
# resp.assessment.metadata.last_updated #=> Time
# resp.assessment.framework.id #=> String
# resp.assessment.framework.arn #=> String
# resp.assessment.framework.metadata.name #=> String
# resp.assessment.framework.metadata.description #=> String
# resp.assessment.framework.metadata.logo #=> String
# resp.assessment.framework.metadata.compliance_type #=> String
# resp.assessment.framework.control_sets #=> Array
# resp.assessment.framework.control_sets[0].id #=> String
# resp.assessment.framework.control_sets[0].description #=> String
# resp.assessment.framework.control_sets[0].status #=> String, one of "ACTIVE", "UNDER_REVIEW", "REVIEWED"
# resp.assessment.framework.control_sets[0].roles #=> Array
# resp.assessment.framework.control_sets[0].roles[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].roles[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].controls #=> Array
# resp.assessment.framework.control_sets[0].controls[0].id #=> String
# resp.assessment.framework.control_sets[0].controls[0].name #=> String
# resp.assessment.framework.control_sets[0].controls[0].description #=> String
# resp.assessment.framework.control_sets[0].controls[0].status #=> String, one of "UNDER_REVIEW", "REVIEWED", "INACTIVE"
# resp.assessment.framework.control_sets[0].controls[0].response #=> String, one of "MANUAL", "AUTOMATE", "DEFER", "IGNORE"
# resp.assessment.framework.control_sets[0].controls[0].comments #=> Array
# resp.assessment.framework.control_sets[0].controls[0].comments[0].author_name #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].comment_body #=> String
# resp.assessment.framework.control_sets[0].controls[0].comments[0].posted_date #=> Time
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources #=> Array
# resp.assessment.framework.control_sets[0].controls[0].evidence_sources[0] #=> String
# resp.assessment.framework.control_sets[0].controls[0].evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].controls[0].assessment_report_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].delegations #=> Array
# resp.assessment.framework.control_sets[0].delegations[0].id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_name #=> String
# resp.assessment.framework.control_sets[0].delegations[0].assessment_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].status #=> String, one of "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE"
# resp.assessment.framework.control_sets[0].delegations[0].role_arn #=> String
# resp.assessment.framework.control_sets[0].delegations[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.assessment.framework.control_sets[0].delegations[0].creation_time #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].last_updated #=> Time
# resp.assessment.framework.control_sets[0].delegations[0].control_set_id #=> String
# resp.assessment.framework.control_sets[0].delegations[0].comment #=> String
# resp.assessment.framework.control_sets[0].delegations[0].created_by #=> String
# resp.assessment.framework.control_sets[0].system_evidence_count #=> Integer
# resp.assessment.framework.control_sets[0].manual_evidence_count #=> Integer
# resp.assessment.tags #=> Hash
# resp.assessment.tags["TagKey"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus AWS API Documentation
#
# @overload update_assessment_status(params = {})
# @param [Hash] params ({})
def update_assessment_status(params = {}, options = {})
req = build_request(:update_assessment_status, params)
req.send_request(options)
end
# Updates a custom control in Audit Manager.
#
# @option params [required, String] :control_id
# The identifier for the control.
#
# @option params [required, String] :name
# The name of the updated control.
#
# @option params [String] :description
# The optional description of the control.
#
# @option params [String] :testing_information
# The steps that you should follow to determine if the control is met.
#
# @option params [String] :action_plan_title
# The title of the action plan for remediating the control.
#
# @option params [String] :action_plan_instructions
# The recommended actions to carry out if the control isn't fulfilled.
#
# @option params [required, Array<Types::ControlMappingSource>] :control_mapping_sources
# The data mapping sources for the control.
#
# @return [Types::UpdateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateControlResponse#control #control} => Types::Control
#
# @example Request syntax with placeholder values
#
# resp = client.update_control({
# control_id: "UUID", # required
# name: "ControlName", # required
# description: "ControlDescription",
# testing_information: "TestingInformation",
# action_plan_title: "ActionPlanTitle",
# action_plan_instructions: "ActionPlanInstructions",
# control_mapping_sources: [ # required
# {
# source_id: "UUID",
# source_name: "SourceName",
# source_description: "SourceDescription",
# source_set_up_option: "System_Controls_Mapping", # accepts System_Controls_Mapping, Procedural_Controls_Mapping
# source_type: "AWS_Cloudtrail", # accepts AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, MANUAL, Common_Control, Core_Control
# source_keyword: {
# keyword_input_type: "SELECT_FROM_LIST", # accepts SELECT_FROM_LIST, UPLOAD_FILE, INPUT_TEXT
# keyword_value: "KeywordValue",
# },
# source_frequency: "DAILY", # accepts DAILY, WEEKLY, MONTHLY
# troubleshooting_text: "TroubleshootingText",
# },
# ],
# })
#
# @example Response structure
#
# resp.control.arn #=> String
# resp.control.id #=> String
# resp.control.type #=> String, one of "Standard", "Custom", "Core"
# resp.control.name #=> String
# resp.control.description #=> String
# resp.control.testing_information #=> String
# resp.control.action_plan_title #=> String
# resp.control.action_plan_instructions #=> String
# resp.control.control_sources #=> String
# resp.control.control_mapping_sources #=> Array
# resp.control.control_mapping_sources[0].source_id #=> String
# resp.control.control_mapping_sources[0].source_name #=> String
# resp.control.control_mapping_sources[0].source_description #=> String
# resp.control.control_mapping_sources[0].source_set_up_option #=> String, one of "System_Controls_Mapping", "Procedural_Controls_Mapping"
# resp.control.control_mapping_sources[0].source_type #=> String, one of "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control"
# resp.control.control_mapping_sources[0].source_keyword.keyword_input_type #=> String, one of "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT"
# resp.control.control_mapping_sources[0].source_keyword.keyword_value #=> String
# resp.control.control_mapping_sources[0].source_frequency #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
# resp.control.control_mapping_sources[0].troubleshooting_text #=> String
# resp.control.created_at #=> Time
# resp.control.last_updated_at #=> Time
# resp.control.created_by #=> String
# resp.control.last_updated_by #=> String
# resp.control.tags #=> Hash
# resp.control.tags["TagKey"] #=> String
# resp.control.state #=> String, one of "ACTIVE", "END_OF_SUPPORT"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl AWS API Documentation
#
# @overload update_control(params = {})
# @param [Hash] params ({})
def update_control(params = {}, options = {})
req = build_request(:update_control, params)
req.send_request(options)
end
# Updates Audit Manager settings for the current account.
#
# @option params [String] :sns_topic
# The Amazon Simple Notification Service (Amazon SNS) topic that Audit
# Manager sends notifications to.
#
# @option params [Types::AssessmentReportsDestination] :default_assessment_reports_destination
# The default S3 destination bucket for storing assessment reports.
#
# @option params [Array<Types::Role>] :default_process_owners
# A list of the default audit owners.
#
# @option params [String] :kms_key
# The KMS key details.
#
# @option params [Boolean] :evidence_finder_enabled
# Specifies whether the evidence finder feature is enabled. Change this
# attribute to enable or disable evidence finder.
#
# When you use this attribute to disable evidence finder, Audit Manager
# deletes the event data store that’s used to query your evidence data.
# As a result, you can’t re-enable evidence finder and use the feature
# again. Your only alternative is to [deregister][1] and then
# [re-register][2] Audit Manager.
#
#
#
# [1]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html
#
# @option params [Types::DeregistrationPolicy] :deregistration_policy
# The deregistration policy for your Audit Manager data. You can use
# this attribute to determine how your data is handled when you
# deregister Audit Manager.
#
# @option params [Types::DefaultExportDestination] :default_export_destination
# The default S3 destination bucket for storing evidence finder exports.
#
# @return [Types::UpdateSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateSettingsResponse#settings #settings} => Types::Settings
#
# @example Request syntax with placeholder values
#
# resp = client.update_settings({
# sns_topic: "SnsArn",
# default_assessment_reports_destination: {
# destination_type: "S3", # accepts S3
# destination: "S3Url",
# },
# default_process_owners: [
# {
# role_type: "PROCESS_OWNER", # required, accepts PROCESS_OWNER, RESOURCE_OWNER
# role_arn: "IamArn", # required
# },
# ],
# kms_key: "KmsKey",
# evidence_finder_enabled: false,
# deregistration_policy: {
# delete_resources: "ALL", # accepts ALL, DEFAULT
# },
# default_export_destination: {
# destination_type: "S3", # accepts S3
# destination: "S3Url",
# },
# })
#
# @example Response structure
#
# resp.settings.is_aws_org_enabled #=> Boolean
# resp.settings.sns_topic #=> String
# resp.settings.default_assessment_reports_destination.destination_type #=> String, one of "S3"
# resp.settings.default_assessment_reports_destination.destination #=> String
# resp.settings.default_process_owners #=> Array
# resp.settings.default_process_owners[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
# resp.settings.default_process_owners[0].role_arn #=> String
# resp.settings.kms_key #=> String
# resp.settings.evidence_finder_enablement.event_data_store_arn #=> String
# resp.settings.evidence_finder_enablement.enablement_status #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS"
# resp.settings.evidence_finder_enablement.backfill_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
# resp.settings.evidence_finder_enablement.error #=> String
# resp.settings.deregistration_policy.delete_resources #=> String, one of "ALL", "DEFAULT"
# resp.settings.default_export_destination.destination_type #=> String, one of "S3"
# resp.settings.default_export_destination.destination #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings AWS API Documentation
#
# @overload update_settings(params = {})
# @param [Hash] params ({})
def update_settings(params = {}, options = {})
req = build_request(:update_settings, params)
req.send_request(options)
end
# Validates the integrity of an assessment report in Audit Manager.
#
# @option params [required, String] :s3_relative_path
# The relative path of the Amazon S3 bucket that the assessment report
# is stored in.
#
# @return [Types::ValidateAssessmentReportIntegrityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ValidateAssessmentReportIntegrityResponse#signature_valid #signature_valid} => Boolean
# * {Types::ValidateAssessmentReportIntegrityResponse#signature_algorithm #signature_algorithm} => String
# * {Types::ValidateAssessmentReportIntegrityResponse#signature_date_time #signature_date_time} => String
# * {Types::ValidateAssessmentReportIntegrityResponse#signature_key_id #signature_key_id} => String
# * {Types::ValidateAssessmentReportIntegrityResponse#validation_errors #validation_errors} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.validate_assessment_report_integrity({
# s3_relative_path: "S3Url", # required
# })
#
# @example Response structure
#
# resp.signature_valid #=> Boolean
# resp.signature_algorithm #=> String
# resp.signature_date_time #=> String
# resp.signature_key_id #=> String
# resp.validation_errors #=> Array
# resp.validation_errors[0] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity AWS API Documentation
#
# @overload validate_assessment_report_integrity(params = {})
# @param [Hash] params ({})
def validate_assessment_report_integrity(params = {}, options = {})
req = build_request(:validate_assessment_report_integrity, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
tracer = config.telemetry_provider.tracer_provider.tracer(
Aws::Telemetry.module_to_tracer_name('Aws::AuditManager')
)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config,
tracer: tracer
)
context[:gem_name] = 'aws-sdk-auditmanager'
context[:gem_version] = '1.53.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated
def waiter_names
[]
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end