« blib/lib/Paws/SSM/ScheduledWindowExecution.pm
↑ Summary
blib/lib/Paws/SSM/SendAutomationSignalResult.pm »
| 1 | |||
| 2 | package Paws::SSM::SendAutomationSignal; | ||
| 3 | use Moose; | ||
| 4 | has AutomationExecutionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Payload => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 6 | has SignalType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendAutomationSignal'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::SendAutomationSignalResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SSM::SendAutomationSignal - Arguments for method SendAutomationSignal on L<Paws::SSM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SendAutomationSignal on the | ||
| 24 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 25 | as arguments to method SendAutomationSignal. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendAutomationSignal. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ssm = Paws->service('SSM'); | ||
| 32 | my $SendAutomationSignalResult = $ssm->SendAutomationSignal( | ||
| 33 | AutomationExecutionId => 'MyAutomationExecutionId', | ||
| 34 | SignalType => 'Approve', | ||
| 35 | Payload => { | ||
| 36 | 'MyAutomationParameterKey' => [ | ||
| 37 | 'MyAutomationParameterValue', ... # min: 1, max: 512 | ||
| 38 | ], # key: min: 1, max: 50, value: max: 50 | ||
| 39 | }, # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/SendAutomationSignal> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> AutomationExecutionId => Str | ||
| 49 | |||
| 50 | The unique identifier for an existing Automation execution that you | ||
| 51 | want to send the signal to. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 Payload => L<Paws::SSM::AutomationParameterMap> | ||
| 56 | |||
| 57 | The data sent with the signal. The data schema depends on the type of | ||
| 58 | signal used in the request. | ||
| 59 | |||
| 60 | For C<Approve> and C<Reject> signal types, the payload is an optional | ||
| 61 | comment that you can send with the signal type. For example: | ||
| 62 | |||
| 63 | C<Comment="Looks good"> | ||
| 64 | |||
| 65 | For C<StartStep> and C<Resume> signal types, you must send the name of | ||
| 66 | the Automation step to start or resume as the payload. For example: | ||
| 67 | |||
| 68 | C<StepName="step1"> | ||
| 69 | |||
| 70 | For the C<StopStep> signal type, you must send the step execution ID as | ||
| 71 | the payload. For example: | ||
| 72 | |||
| 73 | C<StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"> | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> SignalType => Str | ||
| 78 | |||
| 79 | The type of signal to send to an Automation execution. | ||
| 80 | |||
| 81 | Valid values are: C<"Approve">, C<"Reject">, C<"StartStep">, C<"StopStep">, C<"Resume"> | ||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method SendAutomationSignal in L<Paws::SSM> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |