Class: Aws::AuditManager::Types::UpdateAssessmentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb

Overview

Note:

When making an API call, you may pass UpdateAssessmentRequest data as a hash:

{
  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
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_descriptionString

The description of the assessment.

Returns:

  • (String)


4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end

#assessment_idString

The unique identifier for the assessment.

Returns:

  • (String)


4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end

#assessment_nameString

The name of the assessment to be updated.

Returns:

  • (String)


4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end

#assessment_reports_destinationTypes::AssessmentReportsDestination

The assessment report storage destination for the assessment that's being updated.



4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end

#rolesArray<Types::Role>

The list of roles for the assessment.

Returns:



4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end

#scopeTypes::Scope

The scope of the assessment.

Returns:



4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 4926

class UpdateAssessmentRequest < Struct.new(
  :assessment_id,
  :assessment_name,
  :assessment_description,
  :scope,
  :assessment_reports_destination,
  :roles)
  SENSITIVE = []
  include Aws::Structure
end