« blib/lib/Paws/EC2/StaleSecurityGroup.pm
↑ Summary
blib/lib/Paws/EC2/StartNetworkInsightsAnalysisResult.pm »
| 1 | |||
| 2 | package Paws::EC2::StartNetworkInsightsAnalysis; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has FilterInArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'FilterInArn' ); | ||
| 7 | has NetworkInsightsPathId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartNetworkInsightsAnalysis'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::StartNetworkInsightsAnalysisResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::StartNetworkInsightsAnalysis - Arguments for method StartNetworkInsightsAnalysis on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartNetworkInsightsAnalysis on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method StartNetworkInsightsAnalysis. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartNetworkInsightsAnalysis. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $StartNetworkInsightsAnalysisResult = $ec2->StartNetworkInsightsAnalysis( | ||
| 35 | ClientToken => 'MyString', | ||
| 36 | NetworkInsightsPathId => 'MyNetworkInsightsPathId', | ||
| 37 | DryRun => 1, # OPTIONAL | ||
| 38 | FilterInArns => [ | ||
| 39 | 'MyResourceArn', ... # min: 1, max: 1283 | ||
| 40 | ], # OPTIONAL | ||
| 41 | TagSpecifications => [ | ||
| 42 | { | ||
| 43 | ResourceType => 'client-vpn-endpoint' | ||
| 44 | , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL | ||
| 45 | Tags => [ | ||
| 46 | { | ||
| 47 | Key => 'MyString', | ||
| 48 | Value => 'MyString', | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $NetworkInsightsAnalysis = | ||
| 59 | $StartNetworkInsightsAnalysisResult->NetworkInsightsAnalysis; | ||
| 60 | |||
| 61 | # Returns a L<Paws::EC2::StartNetworkInsightsAnalysisResult> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/StartNetworkInsightsAnalysis> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> ClientToken => Str | ||
| 70 | |||
| 71 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 72 | idempotency of the request. For more information, see How to Ensure | ||
| 73 | Idempotency | ||
| 74 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 DryRun => Bool | ||
| 79 | |||
| 80 | Checks whether you have the required permissions for the action, | ||
| 81 | without actually making the request, and provides an error response. If | ||
| 82 | you have the required permissions, the error response is | ||
| 83 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 FilterInArns => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | The Amazon Resource Names (ARN) of the resources that the path must | ||
| 90 | traverse. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> NetworkInsightsPathId => Str | ||
| 95 | |||
| 96 | The ID of the path. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 101 | |||
| 102 | The tags to apply. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, documenting arguments for method StartNetworkInsightsAnalysis in L<Paws::EC2> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |