iotsecuretunneling

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 5

Documentation

Overview

Package iotsecuretunneling provides the client and types for making API requests to AWS IoT Secure Tunneling.

AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field.

For more information about how AWS IoT Secure Tunneling works, see the User Guide (https://docs.aws.amazon.com/secure-tunneling/latest/ug/what-is-secure-tunneling.html).

See https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05 for more information on this service.

See iotsecuretunneling package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsecuretunneling/

Using the Client

To use AWS IoT Secure Tunneling with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Secure Tunneling client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsecuretunneling/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT Secure Tunneling" // Service's name
	ServiceID   = "IoTSecureTunneling"       // Service's identifier
	EndpointsID = "api.tunneling.iot"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Thrown when a tunnel limit is exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Thrown when an operation is attempted on a resource that does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Secure Tunneling. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := iotsecuretunneling.New(myConfig)

func (*Client) CloseTunnelRequest 

func (c *Client) CloseTunnelRequest(input *CloseTunnelInput) CloseTunnelRequest

CloseTunnelRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted. 

// Example sending a request using CloseTunnelRequest.
req := client.CloseTunnelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/CloseTunnel

func (*Client) DescribeTunnelRequest 

func (c *Client) DescribeTunnelRequest(input *DescribeTunnelInput) DescribeTunnelRequest

DescribeTunnelRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

Gets information about a tunnel identified by the unique tunnel id. 

// Example sending a request using DescribeTunnelRequest.
req := client.DescribeTunnelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/DescribeTunnel

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

Lists the tags for the specified resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/ListTagsForResource

func (*Client) ListTunnelsRequest 

func (c *Client) ListTunnelsRequest(input *ListTunnelsInput) ListTunnelsRequest

ListTunnelsRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels. 

// Example sending a request using ListTunnelsRequest.
req := client.ListTunnelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/ListTunnels

func (*Client) OpenTunnelRequest 

func (c *Client) OpenTunnelRequest(input *OpenTunnelInput) OpenTunnelRequest

OpenTunnelRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. . 

// Example sending a request using OpenTunnelRequest.
req := client.OpenTunnelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/OpenTunnel

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

A resource tag. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS IoT Secure Tunneling.

Removes a tag from a resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/UntagResource

type CloseTunnelInput 

type CloseTunnelInput struct {

	// When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.
	Delete *bool `locationName:"delete" type:"boolean"`

	// The ID of the tunnel to close.
	//
	// TunnelId is a required field
	TunnelId *string `locationName:"tunnelId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CloseTunnelInput) String 

func (s CloseTunnelInput) String() string

String returns the string representation

func (*CloseTunnelInput) Validate 

func (s *CloseTunnelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CloseTunnelOutput 

type CloseTunnelOutput struct {
	// contains filtered or unexported fields
}

func (CloseTunnelOutput) String 

func (s CloseTunnelOutput) String() string

String returns the string representation

type CloseTunnelRequest 

type CloseTunnelRequest struct {
	*aws.Request
	Input *CloseTunnelInput
	Copy  func(*CloseTunnelInput) CloseTunnelRequest
}

CloseTunnelRequest is the request type for the CloseTunnel API operation.

func (CloseTunnelRequest) Send 

func (r CloseTunnelRequest) Send(ctx context.Context) (*CloseTunnelResponse, error)

Send marshals and sends the CloseTunnel API request.

type CloseTunnelResponse 

type CloseTunnelResponse struct {
	*CloseTunnelOutput
	// contains filtered or unexported fields
}

CloseTunnelResponse is the response type for the CloseTunnel API operation.

func (*CloseTunnelResponse) SDKResponseMetdata 

func (r *CloseTunnelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CloseTunnel request.

type ConnectionState 

type ConnectionState struct {

	// The last time the connection status was updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.
	Status ConnectionStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The state of a connection.

func (ConnectionState) String 

func (s ConnectionState) String() string

String returns the string representation

type ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusConnected    ConnectionStatus = "CONNECTED"
	ConnectionStatusDisconnected ConnectionStatus = "DISCONNECTED"
)

Enum values for ConnectionStatus

func (ConnectionStatus) MarshalValue 

func (enum ConnectionStatus) MarshalValue() (string, error)

func (ConnectionStatus) MarshalValueBuf 

func (enum ConnectionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DescribeTunnelInput 

type DescribeTunnelInput struct {

	// The tunnel to describe.
	//
	// TunnelId is a required field
	TunnelId *string `locationName:"tunnelId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTunnelInput) String 

func (s DescribeTunnelInput) String() string

String returns the string representation

func (*DescribeTunnelInput) Validate 

func (s *DescribeTunnelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTunnelOutput 

type DescribeTunnelOutput struct {

	// The tunnel being described.
	Tunnel *Tunnel `locationName:"tunnel" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTunnelOutput) String 

func (s DescribeTunnelOutput) String() string

String returns the string representation

type DescribeTunnelRequest 

type DescribeTunnelRequest struct {
	*aws.Request
	Input *DescribeTunnelInput
	Copy  func(*DescribeTunnelInput) DescribeTunnelRequest
}

DescribeTunnelRequest is the request type for the DescribeTunnel API operation.

func (DescribeTunnelRequest) Send 

func (r DescribeTunnelRequest) Send(ctx context.Context) (*DescribeTunnelResponse, error)

Send marshals and sends the DescribeTunnel API request.

type DescribeTunnelResponse 

type DescribeTunnelResponse struct {
	*DescribeTunnelOutput
	// contains filtered or unexported fields
}

DescribeTunnelResponse is the response type for the DescribeTunnel API operation.

func (*DescribeTunnelResponse) SDKResponseMetdata 

func (r *DescribeTunnelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTunnel request.

type DestinationConfig 

type DestinationConfig struct {

	// A list of service names that identity the target application. Currently,
	// you can only specify a single name. The AWS IoT client running on the destination
	// device reads this value and uses it to look up a port or an IP address and
	// a port. The AWS IoT client instantiates the local proxy which uses this information
	// to connect to the destination application.
	//
	// Services is a required field
	Services []string `locationName:"services" min:"1" type:"list" required:"true"`

	// The name of the IoT thing to which you want to connect.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The destination configuration.

func (DestinationConfig) String 

func (s DestinationConfig) String() string

String returns the string representation

func (*DestinationConfig) Validate 

func (s *DestinationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the specified resource.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTunnelsInput 

type ListTunnelsInput struct {

	// The maximum number of results to return at once.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The name of the IoT thing associated with the destination device.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTunnelsInput) String 

func (s ListTunnelsInput) String() string

String returns the string representation

func (*ListTunnelsInput) Validate 

func (s *ListTunnelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTunnelsOutput 

type ListTunnelsOutput struct {

	// A token to used to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A short description of the tunnels in an AWS account.
	TunnelSummaries []TunnelSummary `locationName:"tunnelSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListTunnelsOutput) String 

func (s ListTunnelsOutput) String() string

String returns the string representation

type ListTunnelsPaginator 

type ListTunnelsPaginator struct {
	aws.Pager
}

ListTunnelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTunnelsPaginator 

func NewListTunnelsPaginator(req ListTunnelsRequest) ListTunnelsPaginator

NewListTunnelsRequestPaginator returns a paginator for ListTunnels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTunnelsRequest(input)
p := iotsecuretunneling.NewListTunnelsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTunnelsPaginator) CurrentPage 

func (p *ListTunnelsPaginator) CurrentPage() *ListTunnelsOutput

type ListTunnelsRequest 

type ListTunnelsRequest struct {
	*aws.Request
	Input *ListTunnelsInput
	Copy  func(*ListTunnelsInput) ListTunnelsRequest
}

ListTunnelsRequest is the request type for the ListTunnels API operation.

func (ListTunnelsRequest) Send 

func (r ListTunnelsRequest) Send(ctx context.Context) (*ListTunnelsResponse, error)

Send marshals and sends the ListTunnels API request.

type ListTunnelsResponse 

type ListTunnelsResponse struct {
	*ListTunnelsOutput
	// contains filtered or unexported fields
}

ListTunnelsResponse is the response type for the ListTunnels API operation.

func (*ListTunnelsResponse) SDKResponseMetdata 

func (r *ListTunnelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTunnels request.

type OpenTunnelInput 

type OpenTunnelInput struct {

	// A short text description of the tunnel.
	Description *string `locationName:"description" type:"string"`

	// The destination configuration for the OpenTunnel request.
	DestinationConfig *DestinationConfig `locationName:"destinationConfig" type:"structure"`

	// A collection of tag metadata.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`

	// Timeout configuration for a tunnel.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (OpenTunnelInput) String 

func (s OpenTunnelInput) String() string

String returns the string representation

func (*OpenTunnelInput) Validate 

func (s *OpenTunnelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpenTunnelOutput 

type OpenTunnelOutput struct {

	// The access token the destination local proxy uses to connect to AWS IoT Secure
	// Tunneling.
	DestinationAccessToken *string `locationName:"destinationAccessToken" type:"string" sensitive:"true"`

	// The access token the source local proxy uses to connect to AWS IoT Secure
	// Tunneling.
	SourceAccessToken *string `locationName:"sourceAccessToken" type:"string" sensitive:"true"`

	// The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
	TunnelArn *string `locationName:"tunnelArn" min:"1" type:"string"`

	// A unique alpha-numeric tunnel ID.
	TunnelId *string `locationName:"tunnelId" type:"string"`
	// contains filtered or unexported fields
}

func (OpenTunnelOutput) String 

func (s OpenTunnelOutput) String() string

String returns the string representation

type OpenTunnelRequest 

type OpenTunnelRequest struct {
	*aws.Request
	Input *OpenTunnelInput
	Copy  func(*OpenTunnelInput) OpenTunnelRequest
}

OpenTunnelRequest is the request type for the OpenTunnel API operation.

func (OpenTunnelRequest) Send 

func (r OpenTunnelRequest) Send(ctx context.Context) (*OpenTunnelResponse, error)

Send marshals and sends the OpenTunnel API request.

type OpenTunnelResponse 

type OpenTunnelResponse struct {
	*OpenTunnelOutput
	// contains filtered or unexported fields
}

OpenTunnelResponse is the response type for the OpenTunnel API operation.

func (*OpenTunnelResponse) SDKResponseMetdata 

func (r *OpenTunnelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the OpenTunnel request.

type Tag 

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The tags for the resource.
	//
	// Tags is a required field
	Tags []Tag `locationName:"tags" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TimeoutConfig 

type TimeoutConfig struct {

	// The maximum amount of time (in minutes) a tunnel can remain open. If not
	// specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values
	// are from 1 minute to 12 hours (720 minutes)
	MaxLifetimeTimeoutMinutes *int64 `locationName:"maxLifetimeTimeoutMinutes" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Tunnel timeout configuration.

func (TimeoutConfig) String 

func (s TimeoutConfig) String() string

String returns the string representation

func (*TimeoutConfig) Validate 

func (s *TimeoutConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tunnel 

type Tunnel struct {

	// The time when the tunnel was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A description of the tunnel.
	Description *string `locationName:"description" type:"string"`

	// The destination configuration that specifies the thing name of the destination
	// device and a service name that the local proxy uses to connect to the destination
	// application.
	DestinationConfig *DestinationConfig `locationName:"destinationConfig" type:"structure"`

	// The connection state of the destination application.
	DestinationConnectionState *ConnectionState `locationName:"destinationConnectionState" type:"structure"`

	// The last time the tunnel was updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The connection state of the source application.
	SourceConnectionState *ConnectionState `locationName:"sourceConnectionState" type:"structure"`

	// The status of a tunnel. Valid values are: Open and Closed.
	Status TunnelStatus `locationName:"status" type:"string" enum:"true"`

	// A list of tag metadata associated with the secure tunnel.
	Tags []Tag `locationName:"tags" min:"1" type:"list"`

	// Timeout configuration for the tunnel.
	TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"`

	// The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
	TunnelArn *string `locationName:"tunnelArn" min:"1" type:"string"`

	// A unique alpha-numeric ID that identifies a tunnel.
	TunnelId *string `locationName:"tunnelId" type:"string"`
	// contains filtered or unexported fields
}

A connection between a source computer and a destination device.

func (Tunnel) String 

func (s Tunnel) String() string

String returns the string representation

type TunnelStatus 

type TunnelStatus string
const (
	TunnelStatusOpen   TunnelStatus = "OPEN"
	TunnelStatusClosed TunnelStatus = "CLOSED"
)

Enum values for TunnelStatus

func (TunnelStatus) MarshalValue 

func (enum TunnelStatus) MarshalValue() (string, error)

func (TunnelStatus) MarshalValueBuf 

func (enum TunnelStatus) MarshalValueBuf(b []byte) ([]byte, error)

type TunnelSummary 

type TunnelSummary struct {

	// The time the tunnel was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A description of the tunnel.
	Description *string `locationName:"description" type:"string"`

	// The time the tunnel was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The status of a tunnel. Valid values are: Open and Closed.
	Status TunnelStatus `locationName:"status" type:"string" enum:"true"`

	// The Amazon Resource Name of the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
	TunnelArn *string `locationName:"tunnelArn" min:"1" type:"string"`

	// The unique alpha-numeric identifier for the tunnel.
	TunnelId *string `locationName:"tunnelId" type:"string"`
	// contains filtered or unexported fields
}

Information about the tunnel.

func (TunnelSummary) String 

func (s TunnelSummary) String() string

String returns the string representation

type UntagResourceInput 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The keys of the tags to remove.
	//
	// TagKeys is a required field
	TagKeys []string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

Source Files

View all Source files

Directories

Path Synopsis
Package iotsecuretunnelingiface provides an interface to enable mocking the AWS IoT Secure Tunneling service client for testing your code.
 Package iotsecuretunnelingiface provides an interface to enable mocking the AWS IoT Secure Tunneling service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.