| 1 | |||
| 2 | package Paws::SSMContacts::StartEngagement; | ||
| 3 | use Moose; | ||
| 4 | has ContactId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Content => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IdempotencyToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has IncidentId => (is => 'ro', isa => 'Str'); | ||
| 8 | has PublicContent => (is => 'ro', isa => 'Str'); | ||
| 9 | has PublicSubject => (is => 'ro', isa => 'Str'); | ||
| 10 | has Sender => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has Subject => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartEngagement'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMContacts::StartEngagementResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SSMContacts::StartEngagement - Arguments for method StartEngagement on L<Paws::SSMContacts> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method StartEngagement on the | ||
| 29 | L<AWS Systems Manager Incident Manager Contacts|Paws::SSMContacts> service. Use the attributes of this class | ||
| 30 | as arguments to method StartEngagement. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartEngagement. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $ssm-contacts = Paws->service('SSMContacts'); | ||
| 37 | my $StartEngagementResult = $ssm -contacts->StartEngagement( | ||
| 38 | ContactId => 'MySsmContactsArn', | ||
| 39 | Content => 'MyContent', | ||
| 40 | Sender => 'MySender', | ||
| 41 | Subject => 'MySubject', | ||
| 42 | IdempotencyToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 43 | IncidentId => 'MyIncidentId', # OPTIONAL | ||
| 44 | PublicContent => 'MyPublicContent', # OPTIONAL | ||
| 45 | PublicSubject => 'MyPublicSubject', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $EngagementArn = $StartEngagementResult->EngagementArn; | ||
| 50 | |||
| 51 | # Returns a L<Paws::SSMContacts::StartEngagementResult> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts/StartEngagement> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ContactId => Str | ||
| 60 | |||
| 61 | The Amazon Resource Name (ARN) of the contact being engaged. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> Content => Str | ||
| 66 | |||
| 67 | The secure content of the message that was sent to the contact. Use | ||
| 68 | this field for engagements to C<VOICE> or C<EMAIL>. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 IdempotencyToken => Str | ||
| 73 | |||
| 74 | A token ensuring that the action is called only once with the specified | ||
| 75 | details. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 IncidentId => Str | ||
| 80 | |||
| 81 | The ARN of the incident that the engagement is part of. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 PublicContent => Str | ||
| 86 | |||
| 87 | The insecure content of the message that was sent to the contact. Use | ||
| 88 | this field for engagements to C<SMS>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 PublicSubject => Str | ||
| 93 | |||
| 94 | The insecure subject of the message that was sent to the contact. Use | ||
| 95 | this field for engagements to C<SMS>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Sender => Str | ||
| 100 | |||
| 101 | The user that started the engagement. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> Subject => Str | ||
| 106 | |||
| 107 | The secure subject of the message that was sent to the contact. Use | ||
| 108 | this field for engagements to C<VOICE> or C<EMAIL>. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method StartEngagement in L<Paws::SSMContacts> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |