iotsecuretunneling

package
v1.40.0 Latest Latest
Warning

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

 Go to latest Published: Jul 14, 2021 License: Apache-2.0 Imports: 10 Imported by: 20

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 AWS IoT Secure Tunneling (https://docs.aws.amazon.com/iot/latest/developerguide/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 contact 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 IoTSecureTunneling 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 (
	// ConnectionStatusConnected is a ConnectionStatus enum value
	ConnectionStatusConnected = "CONNECTED"

	// ConnectionStatusDisconnected is a ConnectionStatus enum value
	ConnectionStatusDisconnected = "DISCONNECTED"
)
View Source 
const (
	// TunnelStatusOpen is a TunnelStatus enum value
	TunnelStatusOpen = "OPEN"

	// TunnelStatusClosed is a TunnelStatus enum value
	TunnelStatusClosed = "CLOSED"
)
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"
)
View Source 
const (
	ServiceName = "IoTSecureTunneling" // Name of service.
	EndpointsID = "api.tunneling.iot"  // ID to lookup a service endpoint with.
	ServiceID   = "IoTSecureTunneling" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ConnectionStatus_Values added in v1.34.3 

func ConnectionStatus_Values() []string

ConnectionStatus_Values returns all elements of the ConnectionStatus enum

func TunnelStatus_Values added in v1.34.3 

func TunnelStatus_Values() []string

TunnelStatus_Values returns all elements of the TunnelStatus enum

Types

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) GoString 

func (s CloseTunnelInput) GoString() string

GoString returns the string representation

func (*CloseTunnelInput) SetDelete 

func (s *CloseTunnelInput) SetDelete(v bool) *CloseTunnelInput

SetDelete sets the Delete field's value.

func (*CloseTunnelInput) SetTunnelId 

func (s *CloseTunnelInput) SetTunnelId(v string) *CloseTunnelInput

SetTunnelId sets the TunnelId field's value.

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) GoString 

func (s CloseTunnelOutput) GoString() string

GoString returns the string representation

func (CloseTunnelOutput) String 

func (s CloseTunnelOutput) String() string

String returns the string representation

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 *string `locationName:"status" type:"string" enum:"ConnectionStatus"`
	// contains filtered or unexported fields
}

The state of a connection.

func (ConnectionState) GoString 

func (s ConnectionState) GoString() string

GoString returns the string representation

func (*ConnectionState) SetLastUpdatedAt 

func (s *ConnectionState) SetLastUpdatedAt(v time.Time) *ConnectionState

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*ConnectionState) SetStatus 

func (s *ConnectionState) SetStatus(v string) *ConnectionState

SetStatus sets the Status field's value.

func (ConnectionState) String 

func (s ConnectionState) String() string

String returns the string representation

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) GoString 

func (s DescribeTunnelInput) GoString() string

GoString returns the string representation

func (*DescribeTunnelInput) SetTunnelId 

func (s *DescribeTunnelInput) SetTunnelId(v string) *DescribeTunnelInput

SetTunnelId sets the TunnelId field's value.

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) GoString 

func (s DescribeTunnelOutput) GoString() string

GoString returns the string representation

func (*DescribeTunnelOutput) SetTunnel 

func (s *DescribeTunnelOutput) SetTunnel(v *Tunnel) *DescribeTunnelOutput

SetTunnel sets the Tunnel field's value.

func (DescribeTunnelOutput) String 

func (s DescribeTunnelOutput) String() string

String returns the string representation

type DestinationConfig 

type DestinationConfig struct {

	// A list of service names that identity the target application. 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 *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The destination configuration.

func (DestinationConfig) GoString 

func (s DestinationConfig) GoString() string

GoString returns the string representation

func (*DestinationConfig) SetServices 

func (s *DestinationConfig) SetServices(v []*string) *DestinationConfig

SetServices sets the Services field's value.

func (*DestinationConfig) SetThingName 

func (s *DestinationConfig) SetThingName(v string) *DestinationConfig

SetThingName sets the ThingName field's value.

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 IoTSecureTunneling 

type IoTSecureTunneling struct {
	*client.Client
}

IoTSecureTunneling 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.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTSecureTunneling

New creates a new instance of the IoTSecureTunneling client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a IoTSecureTunneling client from just a session.
svc := iotsecuretunneling.New(mySession)

// Create a IoTSecureTunneling client with additional configuration
svc := iotsecuretunneling.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTSecureTunneling) CloseTunnel 

func (c *IoTSecureTunneling) CloseTunnel(input *CloseTunnelInput) (*CloseTunnelOutput, error)

CloseTunnel 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation CloseTunnel for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Thrown when an operation is attempted on a resource that does not exist.

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

func (*IoTSecureTunneling) CloseTunnelRequest 

func (c *IoTSecureTunneling) CloseTunnelRequest(input *CloseTunnelInput) (req *request.Request, output *CloseTunnelOutput)

CloseTunnelRequest generates a "aws/request.Request" representing the client's request for the CloseTunnel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CloseTunnel for more information on using the CloseTunnel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CloseTunnelRequest method.
req, resp := client.CloseTunnelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) CloseTunnelWithContext 

func (c *IoTSecureTunneling) CloseTunnelWithContext(ctx aws.Context, input *CloseTunnelInput, opts ...request.Option) (*CloseTunnelOutput, error)

CloseTunnelWithContext is the same as CloseTunnel with the addition of the ability to pass a context and additional request options.

See CloseTunnel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) DescribeTunnel 

func (c *IoTSecureTunneling) DescribeTunnel(input *DescribeTunnelInput) (*DescribeTunnelOutput, error)

DescribeTunnel API operation for AWS IoT Secure Tunneling.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation DescribeTunnel for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Thrown when an operation is attempted on a resource that does not exist.

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

func (*IoTSecureTunneling) DescribeTunnelRequest 

func (c *IoTSecureTunneling) DescribeTunnelRequest(input *DescribeTunnelInput) (req *request.Request, output *DescribeTunnelOutput)

DescribeTunnelRequest generates a "aws/request.Request" representing the client's request for the DescribeTunnel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTunnel for more information on using the DescribeTunnel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTunnelRequest method.
req, resp := client.DescribeTunnelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) DescribeTunnelWithContext 

func (c *IoTSecureTunneling) DescribeTunnelWithContext(ctx aws.Context, input *DescribeTunnelInput, opts ...request.Option) (*DescribeTunnelOutput, error)

DescribeTunnelWithContext is the same as DescribeTunnel with the addition of the ability to pass a context and additional request options.

See DescribeTunnel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) ListTagsForResource 

func (c *IoTSecureTunneling) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT Secure Tunneling.

Lists the tags for the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Thrown when an operation is attempted on a resource that does not exist.

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

func (*IoTSecureTunneling) ListTagsForResourceRequest 

func (c *IoTSecureTunneling) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) ListTagsForResourceWithContext 

func (c *IoTSecureTunneling) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) ListTunnels 

func (c *IoTSecureTunneling) ListTunnels(input *ListTunnelsInput) (*ListTunnelsOutput, error)

ListTunnels 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation ListTunnels for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/iotsecuretunneling-2018-10-05/ListTunnels

func (*IoTSecureTunneling) ListTunnelsPages 

func (c *IoTSecureTunneling) ListTunnelsPages(input *ListTunnelsInput, fn func(*ListTunnelsOutput, bool) bool) error

ListTunnelsPages iterates over the pages of a ListTunnels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTunnels method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTunnels operation.
pageNum := 0
err := client.ListTunnelsPages(params,
    func(page *iotsecuretunneling.ListTunnelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSecureTunneling) ListTunnelsPagesWithContext 

func (c *IoTSecureTunneling) ListTunnelsPagesWithContext(ctx aws.Context, input *ListTunnelsInput, fn func(*ListTunnelsOutput, bool) bool, opts ...request.Option) error

ListTunnelsPagesWithContext same as ListTunnelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) ListTunnelsRequest 

func (c *IoTSecureTunneling) ListTunnelsRequest(input *ListTunnelsInput) (req *request.Request, output *ListTunnelsOutput)

ListTunnelsRequest generates a "aws/request.Request" representing the client's request for the ListTunnels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTunnels for more information on using the ListTunnels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTunnelsRequest method.
req, resp := client.ListTunnelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) ListTunnelsWithContext 

func (c *IoTSecureTunneling) ListTunnelsWithContext(ctx aws.Context, input *ListTunnelsInput, opts ...request.Option) (*ListTunnelsOutput, error)

ListTunnelsWithContext is the same as ListTunnels with the addition of the ability to pass a context and additional request options.

See ListTunnels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) OpenTunnel 

func (c *IoTSecureTunneling) OpenTunnel(input *OpenTunnelInput) (*OpenTunnelOutput, error)

OpenTunnel 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation OpenTunnel for usage and error information.

Returned Error Types:

  • LimitExceededException Thrown when a tunnel limit is exceeded.

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

func (*IoTSecureTunneling) OpenTunnelRequest 

func (c *IoTSecureTunneling) OpenTunnelRequest(input *OpenTunnelInput) (req *request.Request, output *OpenTunnelOutput)

OpenTunnelRequest generates a "aws/request.Request" representing the client's request for the OpenTunnel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See OpenTunnel for more information on using the OpenTunnel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the OpenTunnelRequest method.
req, resp := client.OpenTunnelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) OpenTunnelWithContext 

func (c *IoTSecureTunneling) OpenTunnelWithContext(ctx aws.Context, input *OpenTunnelInput, opts ...request.Option) (*OpenTunnelOutput, error)

OpenTunnelWithContext is the same as OpenTunnel with the addition of the ability to pass a context and additional request options.

See OpenTunnel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) TagResource 

func (c *IoTSecureTunneling) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT Secure Tunneling.

A resource tag.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Thrown when an operation is attempted on a resource that does not exist.

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

func (*IoTSecureTunneling) TagResourceRequest 

func (c *IoTSecureTunneling) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) TagResourceWithContext 

func (c *IoTSecureTunneling) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSecureTunneling) UntagResource 

func (c *IoTSecureTunneling) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT Secure Tunneling.

Removes a tag from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Secure Tunneling's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Thrown when an operation is attempted on a resource that does not exist.

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

func (*IoTSecureTunneling) UntagResourceRequest 

func (c *IoTSecureTunneling) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTSecureTunneling) UntagResourceWithContext 

func (c *IoTSecureTunneling) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when a tunnel limit is exceeded.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation

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) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

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) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

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) GoString 

func (s ListTunnelsInput) GoString() string

GoString returns the string representation

func (*ListTunnelsInput) SetMaxResults 

func (s *ListTunnelsInput) SetMaxResults(v int64) *ListTunnelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTunnelsInput) SetNextToken 

func (s *ListTunnelsInput) SetNextToken(v string) *ListTunnelsInput

SetNextToken sets the NextToken field's value.

func (*ListTunnelsInput) SetThingName 

func (s *ListTunnelsInput) SetThingName(v string) *ListTunnelsInput

SetThingName sets the ThingName field's value.

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) GoString 

func (s ListTunnelsOutput) GoString() string

GoString returns the string representation

func (*ListTunnelsOutput) SetNextToken 

func (s *ListTunnelsOutput) SetNextToken(v string) *ListTunnelsOutput

SetNextToken sets the NextToken field's value.

func (*ListTunnelsOutput) SetTunnelSummaries 

func (s *ListTunnelsOutput) SetTunnelSummaries(v []*TunnelSummary) *ListTunnelsOutput

SetTunnelSummaries sets the TunnelSummaries field's value.

func (ListTunnelsOutput) String 

func (s ListTunnelsOutput) String() string

String returns the string representation

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) GoString 

func (s OpenTunnelInput) GoString() string

GoString returns the string representation

func (*OpenTunnelInput) SetDescription 

func (s *OpenTunnelInput) SetDescription(v string) *OpenTunnelInput

SetDescription sets the Description field's value.

func (*OpenTunnelInput) SetDestinationConfig 

func (s *OpenTunnelInput) SetDestinationConfig(v *DestinationConfig) *OpenTunnelInput

SetDestinationConfig sets the DestinationConfig field's value.

func (*OpenTunnelInput) SetTags 

func (s *OpenTunnelInput) SetTags(v []*Tag) *OpenTunnelInput

SetTags sets the Tags field's value.

func (*OpenTunnelInput) SetTimeoutConfig 

func (s *OpenTunnelInput) SetTimeoutConfig(v *TimeoutConfig) *OpenTunnelInput

SetTimeoutConfig sets the TimeoutConfig field's value.

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) GoString 

func (s OpenTunnelOutput) GoString() string

GoString returns the string representation

func (*OpenTunnelOutput) SetDestinationAccessToken 

func (s *OpenTunnelOutput) SetDestinationAccessToken(v string) *OpenTunnelOutput

SetDestinationAccessToken sets the DestinationAccessToken field's value.

func (*OpenTunnelOutput) SetSourceAccessToken 

func (s *OpenTunnelOutput) SetSourceAccessToken(v string) *OpenTunnelOutput

SetSourceAccessToken sets the SourceAccessToken field's value.

func (*OpenTunnelOutput) SetTunnelArn 

func (s *OpenTunnelOutput) SetTunnelArn(v string) *OpenTunnelOutput

SetTunnelArn sets the TunnelArn field's value.

func (*OpenTunnelOutput) SetTunnelId 

func (s *OpenTunnelOutput) SetTunnelId(v string) *OpenTunnelOutput

SetTunnelId sets the TunnelId field's value.

func (OpenTunnelOutput) String 

func (s OpenTunnelOutput) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when an operation is attempted on a resource that does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

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) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

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) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

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) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

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) GoString 

func (s TimeoutConfig) GoString() string

GoString returns the string representation

func (*TimeoutConfig) SetMaxLifetimeTimeoutMinutes 

func (s *TimeoutConfig) SetMaxLifetimeTimeoutMinutes(v int64) *TimeoutConfig

SetMaxLifetimeTimeoutMinutes sets the MaxLifetimeTimeoutMinutes field's value.

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 *string `locationName:"status" type:"string" enum:"TunnelStatus"`

	// 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) GoString 

func (s Tunnel) GoString() string

GoString returns the string representation

func (*Tunnel) SetCreatedAt 

func (s *Tunnel) SetCreatedAt(v time.Time) *Tunnel

SetCreatedAt sets the CreatedAt field's value.

func (*Tunnel) SetDescription 

func (s *Tunnel) SetDescription(v string) *Tunnel

SetDescription sets the Description field's value.

func (*Tunnel) SetDestinationConfig 

func (s *Tunnel) SetDestinationConfig(v *DestinationConfig) *Tunnel

SetDestinationConfig sets the DestinationConfig field's value.

func (*Tunnel) SetDestinationConnectionState 

func (s *Tunnel) SetDestinationConnectionState(v *ConnectionState) *Tunnel

SetDestinationConnectionState sets the DestinationConnectionState field's value.

func (*Tunnel) SetLastUpdatedAt 

func (s *Tunnel) SetLastUpdatedAt(v time.Time) *Tunnel

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*Tunnel) SetSourceConnectionState 

func (s *Tunnel) SetSourceConnectionState(v *ConnectionState) *Tunnel

SetSourceConnectionState sets the SourceConnectionState field's value.

func (*Tunnel) SetStatus 

func (s *Tunnel) SetStatus(v string) *Tunnel

SetStatus sets the Status field's value.

func (*Tunnel) SetTags 

func (s *Tunnel) SetTags(v []*Tag) *Tunnel

SetTags sets the Tags field's value.

func (*Tunnel) SetTimeoutConfig 

func (s *Tunnel) SetTimeoutConfig(v *TimeoutConfig) *Tunnel

SetTimeoutConfig sets the TimeoutConfig field's value.

func (*Tunnel) SetTunnelArn 

func (s *Tunnel) SetTunnelArn(v string) *Tunnel

SetTunnelArn sets the TunnelArn field's value.

func (*Tunnel) SetTunnelId 

func (s *Tunnel) SetTunnelId(v string) *Tunnel

SetTunnelId sets the TunnelId field's value.

func (Tunnel) String 

func (s Tunnel) String() string

String returns the string representation

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 *string `locationName:"status" type:"string" enum:"TunnelStatus"`

	// 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) GoString 

func (s TunnelSummary) GoString() string

GoString returns the string representation

func (*TunnelSummary) SetCreatedAt 

func (s *TunnelSummary) SetCreatedAt(v time.Time) *TunnelSummary

SetCreatedAt sets the CreatedAt field's value.

func (*TunnelSummary) SetDescription 

func (s *TunnelSummary) SetDescription(v string) *TunnelSummary

SetDescription sets the Description field's value.

func (*TunnelSummary) SetLastUpdatedAt 

func (s *TunnelSummary) SetLastUpdatedAt(v time.Time) *TunnelSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*TunnelSummary) SetStatus 

func (s *TunnelSummary) SetStatus(v string) *TunnelSummary

SetStatus sets the Status field's value.

func (*TunnelSummary) SetTunnelArn 

func (s *TunnelSummary) SetTunnelArn(v string) *TunnelSummary

SetTunnelArn sets the TunnelArn field's value.

func (*TunnelSummary) SetTunnelId 

func (s *TunnelSummary) SetTunnelId(v string) *TunnelSummary

SetTunnelId sets the TunnelId field's value.

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) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

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) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

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.