« blib/lib/Paws/EC2/CancelImportTaskResult.pm
↑ Summary
blib/lib/Paws/EC2/CancelSpotFleetRequestsError.pm »
| 1 | |||
| 2 | package Paws::EC2::CancelSpotFleetRequests; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | ||
| 5 | has SpotFleetRequestIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'spotFleetRequestId' , required => 1); | ||
| 6 | has TerminateInstances => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'terminateInstances' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CancelSpotFleetRequests'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CancelSpotFleetRequestsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::EC2::CancelSpotFleetRequests - Arguments for method CancelSpotFleetRequests on L<Paws::EC2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CancelSpotFleetRequests on the | ||
| 24 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 25 | as arguments to method CancelSpotFleetRequests. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CancelSpotFleetRequests. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ec2 = Paws->service('EC2'); | ||
| 32 | # To cancel a Spot fleet request | ||
| 33 | # This example cancels the specified Spot fleet request and terminates its | ||
| 34 | # associated Spot Instances. | ||
| 35 | my $CancelSpotFleetRequestsResponse = $ec2->CancelSpotFleetRequests( | ||
| 36 | 'SpotFleetRequestIds' => ['sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE'], | ||
| 37 | 'TerminateInstances' => 1 | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $SuccessfulFleetRequests = | ||
| 42 | $CancelSpotFleetRequestsResponse->SuccessfulFleetRequests; | ||
| 43 | |||
| 44 | # Returns a L<Paws::EC2::CancelSpotFleetRequestsResponse> object. | ||
| 45 | # To cancel a Spot fleet request without terminating its Spot Instances | ||
| 46 | # This example cancels the specified Spot fleet request without terminating its | ||
| 47 | # associated Spot Instances. | ||
| 48 | my $CancelSpotFleetRequestsResponse = $ec2->CancelSpotFleetRequests( | ||
| 49 | 'SpotFleetRequestIds' => ['sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE'], | ||
| 50 | 'TerminateInstances' => 0 | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $SuccessfulFleetRequests = | ||
| 55 | $CancelSpotFleetRequestsResponse->SuccessfulFleetRequests; | ||
| 56 | |||
| 57 | # Returns a L<Paws::EC2::CancelSpotFleetRequestsResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CancelSpotFleetRequests> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DryRun => Bool | ||
| 66 | |||
| 67 | Checks whether you have the required permissions for the action, | ||
| 68 | without actually making the request, and provides an error response. If | ||
| 69 | you have the required permissions, the error response is | ||
| 70 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> SpotFleetRequestIds => ArrayRef[Str|Undef] | ||
| 75 | |||
| 76 | The IDs of the Spot Fleet requests. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> TerminateInstances => Bool | ||
| 81 | |||
| 82 | Indicates whether to terminate instances for a Spot Fleet request if it | ||
| 83 | is canceled successfully. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method CancelSpotFleetRequests in L<Paws::EC2> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |