« blib/lib/Paws/Organizations/AttachPolicy.pm
↑ Summary
blib/lib/Paws/Organizations/CancelHandshakeResponse.pm »
| 1 | |||
| 2 | package Paws::Organizations::CancelHandshake; | ||
| 3 | use Moose; | ||
| 4 | has HandshakeId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CancelHandshake'); | ||
| 9 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::CancelHandshakeResponse'); | ||
| 10 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Organizations::CancelHandshake - Arguments for method CancelHandshake on L<Paws::Organizations> | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | This class represents the parameters used for calling the method CancelHandshake on the | ||
| 22 | L<AWS Organizations|Paws::Organizations> service. Use the attributes of this class | ||
| 23 | as arguments to method CancelHandshake. | ||
| 24 | |||
| 25 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CancelHandshake. | ||
| 26 | |||
| 27 | =head1 SYNOPSIS | ||
| 28 | |||
| 29 | my $organizations = Paws->service('Organizations'); | ||
| 30 | # To cancel a handshake sent to a member account | ||
| 31 | # Bill previously sent an invitation to Susan's account to join his | ||
| 32 | # organization. He changes his mind and decides to cancel the invitation before | ||
| 33 | # Susan accepts it. The following example shows Bill's cancellation: | ||
| 34 | |||
| 35 | my $CancelHandshakeResponse = $organizations->CancelHandshake( | ||
| 36 | 'HandshakeId' => 'h-examplehandshakeid111' ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Handshake = $CancelHandshakeResponse->Handshake; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Organizations::CancelHandshakeResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/organizations/CancelHandshake> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> HandshakeId => Str | ||
| 50 | |||
| 51 | The unique identifier (ID) of the handshake that you want to cancel. | ||
| 52 | You can get the ID from the ListHandshakesForOrganization operation. | ||
| 53 | |||
| 54 | The regex pattern (http://wikipedia.org/wiki/regex) for handshake ID | ||
| 55 | string requires "h-" followed by from 8 to 32 lowercase letters or | ||
| 56 | digits. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head1 SEE ALSO | ||
| 62 | |||
| 63 | This class forms part of L<Paws>, documenting arguments for method CancelHandshake in L<Paws::Organizations> | ||
| 64 | |||
| 65 | =head1 BUGS and CONTRIBUTIONS | ||
| 66 | |||
| 67 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 68 | |||
| 69 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 70 | |||
| 71 | =cut | ||
| 72 |