knad

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ServiceName = "knad"      // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "knad"      // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Knad

type Knad struct {
	*client.Client
}

Knad provides the API operation methods for making requests to knad. See this package's package overview docs for details on the service.

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

func ExtraNew

func ExtraNew(info *utils.UrlInfo, p client.ConfigProvider, cfgs ...*aws.Config) *Knad

extraNew create int can support ssl or region locate set

func New

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

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

Example:

// Create a Knad client from just a session.
svc := knad.New(mySession)

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

func SdkNew

func SdkNew(p client.ConfigProvider, cfgs *ksc.Config, info ...*utils.UrlInfo) *Knad

SdkNew create int can support ssl or region locate set

func (*Knad) AssociateIp

func (c *Knad) AssociateIp(input *map[string]interface{}) (*map[string]interface{}, error)

AssociateIp API operation for knad.

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 KSC API reference guide for knad's API operation AssociateIp for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/AssociateIp

func (*Knad) AssociateIpRequest

func (c *Knad) AssociateIpRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

AssociateIpRequest generates a "ksc/request.Request" representing the client's request for the AssociateIp 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 AssociateIp for more information on using the AssociateIp 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 AssociateIpRequest method.
req, resp := client.AssociateIpRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/AssociateIp

func (*Knad) AssociateIpWithContext

func (c *Knad) AssociateIpWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See AssociateIp 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 (*Knad) CreateKnad

func (c *Knad) CreateKnad(input *map[string]interface{}) (*map[string]interface{}, error)

CreateKnad API operation for knad.

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 KSC API reference guide for knad's API operation CreateKnad for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/CreateKnad

func (*Knad) CreateKnadRequest

func (c *Knad) CreateKnadRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

CreateKnadRequest generates a "ksc/request.Request" representing the client's request for the CreateKnad 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 CreateKnad for more information on using the CreateKnad 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 CreateKnadRequest method.
req, resp := client.CreateKnadRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/CreateKnad

func (*Knad) CreateKnadWithContext

func (c *Knad) CreateKnadWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See CreateKnad 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 (*Knad) DeleteKnad

func (c *Knad) DeleteKnad(input *map[string]interface{}) (*map[string]interface{}, error)

DeleteKnad API operation for knad.

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 KSC API reference guide for knad's API operation DeleteKnad for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DeleteKnad

func (*Knad) DeleteKnadRequest

func (c *Knad) DeleteKnadRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

DeleteKnadRequest generates a "ksc/request.Request" representing the client's request for the DeleteKnad 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 DeleteKnad for more information on using the DeleteKnad 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 DeleteKnadRequest method.
req, resp := client.DeleteKnadRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DeleteKnad

func (*Knad) DeleteKnadWithContext

func (c *Knad) DeleteKnadWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See DeleteKnad 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 (*Knad) DescribeKnad

func (c *Knad) DescribeKnad(input *map[string]interface{}) (*map[string]interface{}, error)

DescribeKnad API operation for knad.

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 KSC API reference guide for knad's API operation DescribeKnad for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DescribeKnad

func (*Knad) DescribeKnadRequest

func (c *Knad) DescribeKnadRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

DescribeKnadRequest generates a "ksc/request.Request" representing the client's request for the DescribeKnad 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 DescribeKnad for more information on using the DescribeKnad 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 DescribeKnadRequest method.
req, resp := client.DescribeKnadRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DescribeKnad

func (*Knad) DescribeKnadWithContext

func (c *Knad) DescribeKnadWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See DescribeKnad 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 (*Knad) DisassociateIp

func (c *Knad) DisassociateIp(input *map[string]interface{}) (*map[string]interface{}, error)

DisassociateIp API operation for knad.

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 KSC API reference guide for knad's API operation DisassociateIp for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DisassociateIp

func (*Knad) DisassociateIpRequest

func (c *Knad) DisassociateIpRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

DisassociateIpRequest generates a "ksc/request.Request" representing the client's request for the DisassociateIp 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 DisassociateIp for more information on using the DisassociateIp 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 DisassociateIpRequest method.
req, resp := client.DisassociateIpRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/DisassociateIp

func (*Knad) DisassociateIpWithContext

func (c *Knad) DisassociateIpWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See DisassociateIp 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 (*Knad) IpList added in v0.2.4

func (c *Knad) IpList(input *map[string]interface{}) (*map[string]interface{}, error)

IpList API operation for knad.

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 KSC API reference guide for knad's API operation IpList for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/IpList

func (*Knad) IpListRequest added in v0.2.4

func (c *Knad) IpListRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

IpListRequest generates a "ksc/request.Request" representing the client's request for the IpList 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 IpList for more information on using the IpList 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 IpListRequest method.
req, resp := client.IpListRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/IpList

func (*Knad) IpListWithContext added in v0.2.4

func (c *Knad) IpListWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See IpList 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 (*Knad) ModifyKnad

func (c *Knad) ModifyKnad(input *map[string]interface{}) (*map[string]interface{}, error)

ModifyKnad API operation for knad.

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 KSC API reference guide for knad's API operation ModifyKnad for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/ModifyKnad

func (*Knad) ModifyKnadRequest

func (c *Knad) ModifyKnadRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

ModifyKnadRequest generates a "ksc/request.Request" representing the client's request for the ModifyKnad 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 ModifyKnad for more information on using the ModifyKnad 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 ModifyKnadRequest method.
req, resp := client.ModifyKnadRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/knad-2023-03-23/ModifyKnad

func (*Knad) ModifyKnadWithContext

func (c *Knad) ModifyKnadWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See ModifyKnad 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.

Directories

Path Synopsis
Package knadiface provides an interface to enable mocking the knad service client for testing your code.
Package knadiface provides an interface to enable mocking the knad service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL