Client

networkmanager

R Documentation

AWS Network Manager¶

Description¶

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

Usage¶

networkmanager(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- networkmanager(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

accept_attachment: Accepts a core network attachment request
associate_connect_peer: Associates a core network Connect peer with a device and optionally, with a link
associate_customer_gateway: Associates a customer gateway with a device and optionally, with a link
associate_link: Associates a link to a device; Associates a transit gateway Connect peer with a device, and optionally, with a link
create_connect_attachment: Creates a core network Connect attachment from a specified core network attachment
create_connection: Creates a connection between two devices
create_connect_peer: Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance
create_core_network: Creates a core network as part of your global network, and optionally, with a core network policy
create_device: Creates a new device in a global network
create_global_network: Creates a new, empty global network
create_link: Creates a new link for a specified site
create_site: Creates a new site in a global network
create_site_to_site_vpn_attachment: Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network
create_transit_gateway_peering: Creates a transit gateway peering connection; Creates a transit gateway route table attachment
create_vpc_attachment: Creates a VPC attachment on an edge location of a core network
delete_attachment: Deletes an attachment
delete_connection: Deletes the specified connection in your global network
delete_connect_peer: Deletes a Connect peer
delete_core_network: Deletes a core network along with all core network policies
delete_core_network_policy_version: Deletes a policy version from a core network
delete_device: Deletes an existing device
delete_global_network: Deletes an existing global network
delete_link: Deletes an existing link
delete_peering: Deletes an existing peering connection
delete_resource_policy: Deletes a resource policy for the specified resource
delete_site: Deletes an existing site
deregister_transit_gateway: Deregisters a transit gateway from your global network
describe_global_networks: Describes one or more global networks
disassociate_connect_peer: Disassociates a core network Connect peer from a device and a link
disassociate_customer_gateway: Disassociates a customer gateway from a device and a link
disassociate_link: Disassociates an existing device from a link; Disassociates a transit gateway Connect peer from a device and link
execute_core_network_change_set: Executes a change set on your core network
get_connect_attachment: Returns information about a core network Connect attachment
get_connections: Gets information about one or more of your connections in a global network
get_connect_peer: Returns information about a core network Connect peer
get_connect_peer_associations: Returns information about a core network Connect peer associations
get_core_network: Returns information about the LIVE policy for a core network
get_core_network_change_events: Returns information about a core network change event
get_core_network_change_set: Returns a change set between the LIVE core network policy and a submitted policy
get_core_network_policy: Returns details about a core network policy
get_customer_gateway_associations: Gets the association information for customer gateways that are associated with devices and links in your global network
get_devices: Gets information about one or more of your devices in a global network
get_link_associations: Gets the link associations for a device or a link
get_links: Gets information about one or more links in a specified global network
get_network_resource_counts: Gets the count of network resources, by resource type, for the specified global network
get_network_resource_relationships: Gets the network resource relationships for the specified global network
get_network_resources: Describes the network resources for the specified global network
get_network_routes: Gets the network routes of the specified global network
get_network_telemetry: Gets the network telemetry of the specified global network
get_resource_policy: Returns information about a resource policy
get_route_analysis: Gets information about the specified route analysis
get_sites: Gets information about one or more of your sites in a global network
get_site_to_site_vpn_attachment: Returns information about a site-to-site VPN attachment; Gets information about one or more of your transit gateway Connect peer associations in a global network
get_transit_gateway_peering: Returns information about a transit gateway peer
get_transit_gateway_registrations: Gets information about the transit gateway registrations in a specified global network; Returns information about a transit gateway route table attachment
get_vpc_attachment: Returns information about a VPC attachment
list_attachments: Returns a list of core network attachments
list_connect_peers: Returns a list of core network Connect peers
list_core_network_policy_versions: Returns a list of core network policy versions
list_core_networks: Returns a list of owned and shared core networks; Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization
list_peerings: Lists the peerings for a core network
list_tags_for_resource: Lists the tags for a specified resource
put_core_network_policy: Creates a new, immutable version of a core network policy
put_resource_policy: Creates or updates a resource policy
register_transit_gateway: Registers a transit gateway in your global network
reject_attachment: Rejects a core network attachment request
restore_core_network_policy_version: Restores a previous policy version as a new, immutable version of a core network policy; Enables the Network Manager service for an Amazon Web Services Organization
start_route_analysis: Starts analyzing the routing path between the specified source and destination
tag_resource: Tags a specified resource
untag_resource: Removes tags from a specified resource
update_connection: Updates the information for an existing connection
update_core_network: Updates the description of a core network
update_device: Updates the details for an existing device
update_global_network: Updates an existing global network
update_link: Updates the details for an existing link
update_network_resource_metadata: Updates the resource metadata for the specified global network
update_site: Updates the information for an existing site
update_vpc_attachment: Updates a VPC attachment

Examples¶

## Not run: 
svc <- networkmanager()
svc$accept_attachment(
  Foo = 123
)

## End(Not run)