Class: Aws::EC2::Types::StartNetworkInsightsAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass StartNetworkInsightsAnalysisRequest data as a hash:

{
  network_insights_path_id: "NetworkInsightsPathId", # required
  filter_in_arns: ["ResourceArn"],
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-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, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, 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-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  client_token: "String", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


63495
63496
63497
63498
63499
63500
63501
63502
63503
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 63495

class StartNetworkInsightsAnalysisRequest < Struct.new(
  :network_insights_path_id,
  :filter_in_arns,
  :dry_run,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


63495
63496
63497
63498
63499
63500
63501
63502
63503
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 63495

class StartNetworkInsightsAnalysisRequest < Struct.new(
  :network_insights_path_id,
  :filter_in_arns,
  :dry_run,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#filter_in_arnsArray<String>

The Amazon Resource Names (ARN) of the resources that the path must traverse.

Returns:

  • (Array<String>)


63495
63496
63497
63498
63499
63500
63501
63502
63503
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 63495

class StartNetworkInsightsAnalysisRequest < Struct.new(
  :network_insights_path_id,
  :filter_in_arns,
  :dry_run,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#network_insights_path_idString

The ID of the path.

Returns:

  • (String)


63495
63496
63497
63498
63499
63500
63501
63502
63503
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 63495

class StartNetworkInsightsAnalysisRequest < Struct.new(
  :network_insights_path_id,
  :filter_in_arns,
  :dry_run,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply.

Returns:



63495
63496
63497
63498
63499
63500
63501
63502
63503
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 63495

class StartNetworkInsightsAnalysisRequest < Struct.new(
  :network_insights_path_id,
  :filter_in_arns,
  :dry_run,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end