« blib/lib/Paws/AuditManager/ControlSet.pm
↑ Summary
blib/lib/Paws/AuditManager/CreateAssessmentFramework.pm »
| 1 | |||
| 2 | package Paws::AuditManager::CreateAssessment; | ||
| 3 | use Moose; | ||
| 4 | has AssessmentReportsDestination => (is => 'ro', isa => 'Paws::AuditManager::AssessmentReportsDestination', traits => ['NameInRequest'], request_name => 'assessmentReportsDestination', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 6 | has FrameworkId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'frameworkId', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 8 | has Roles => (is => 'ro', isa => 'ArrayRef[Paws::AuditManager::Role]', traits => ['NameInRequest'], request_name => 'roles', required => 1); | ||
| 9 | has Scope => (is => 'ro', isa => 'Paws::AuditManager::Scope', traits => ['NameInRequest'], request_name => 'scope', required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'Paws::AuditManager::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAssessment'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assessments'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AuditManager::CreateAssessmentResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::AuditManager::CreateAssessment - Arguments for method CreateAssessment on L<Paws::AuditManager> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateAssessment on the | ||
| 29 | L<AWS Audit Manager|Paws::AuditManager> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateAssessment. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAssessment. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $auditmanager = Paws->service('AuditManager'); | ||
| 37 | my $CreateAssessmentResponse = $auditmanager->CreateAssessment( | ||
| 38 | AssessmentReportsDestination => { | ||
| 39 | Destination => 'MyS3Url', # min: 1, max: 1024; OPTIONAL | ||
| 40 | DestinationType => 'S3', # values: S3; OPTIONAL | ||
| 41 | }, | ||
| 42 | FrameworkId => 'MyUUID', | ||
| 43 | Name => 'MyAssessmentName', | ||
| 44 | Roles => [ | ||
| 45 | { | ||
| 46 | RoleArn => 'MyIamArn', # min: 20, max: 2048; OPTIONAL | ||
| 47 | RoleType => | ||
| 48 | 'PROCESS_OWNER', # values: PROCESS_OWNER, RESOURCE_OWNER; OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], | ||
| 52 | Scope => { | ||
| 53 | AwsAccounts => [ | ||
| 54 | { | ||
| 55 | EmailAddress => 'MyEmailAddress', # min: 1, max: 320; OPTIONAL | ||
| 56 | Id => 'MyAccountId', # min: 12, max: 12; OPTIONAL | ||
| 57 | Name => 'MyAccountName', # min: 1, max: 50; OPTIONAL | ||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | AwsServices => [ | ||
| 62 | { | ||
| 63 | ServiceName => 'MyAWSServiceName', # min: 1, max: 40; OPTIONAL | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | }, | ||
| 68 | Description => 'MyAssessmentDescription', # OPTIONAL | ||
| 69 | Tags => { | ||
| 70 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 71 | }, # OPTIONAL | ||
| 72 | ); | ||
| 73 | |||
| 74 | # Results: | ||
| 75 | my $Assessment = $CreateAssessmentResponse->Assessment; | ||
| 76 | |||
| 77 | # Returns a L<Paws::AuditManager::CreateAssessmentResponse> object. | ||
| 78 | |||
| 79 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 80 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/auditmanager/CreateAssessment> | ||
| 81 | |||
| 82 | =head1 ATTRIBUTES | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> AssessmentReportsDestination => L<Paws::AuditManager::AssessmentReportsDestination> | ||
| 86 | |||
| 87 | The assessment report storage destination for the specified assessment | ||
| 88 | that is being created. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Description => Str | ||
| 93 | |||
| 94 | The optional description of the assessment to be created. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> FrameworkId => Str | ||
| 99 | |||
| 100 | The identifier for the specified framework. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> Name => Str | ||
| 105 | |||
| 106 | The name of the assessment to be created. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> Roles => ArrayRef[L<Paws::AuditManager::Role>] | ||
| 111 | |||
| 112 | The list of roles for the specified assessment. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Scope => L<Paws::AuditManager::Scope> | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 Tags => L<Paws::AuditManager::TagMap> | ||
| 123 | |||
| 124 | The tags associated with the assessment. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method CreateAssessment in L<Paws::AuditManager> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |