script

Documentation

Overview

Package script provides the client and types for making API requests to NIFCLOUD Script.

See https://docs.aws.amazon.com/goto/WebAPI/script-2015-09-01 for more information on this service.

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

Using the Client

To contact NIFCLOUD Script 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 nifcloud.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/nifcloud/#Config

See the NIFCLOUD Script client Script for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/script/#New

Index

• Constants
• type ExecuteScriptInput
  • func (s ExecuteScriptInput) GoString() string
  • func (s *ExecuteScriptInput) SetBody(v string) *ExecuteScriptInput
  • func (s *ExecuteScriptInput) SetHeader(v string) *ExecuteScriptInput
  • func (s *ExecuteScriptInput) SetMethod(v string) *ExecuteScriptInput
  • func (s *ExecuteScriptInput) SetQuery(v string) *ExecuteScriptInput
  • func (s *ExecuteScriptInput) SetScriptIdentifier(v string) *ExecuteScriptInput
  • func (s ExecuteScriptInput) String() string
• type ExecuteScriptOutput
  • func (s ExecuteScriptOutput) GoString() string
  • func (s *ExecuteScriptOutput) SetResult(v *Result) *ExecuteScriptOutput
  • func (s ExecuteScriptOutput) String() string
• type Result
  • func (s Result) GoString() string
  • func (s *Result) SetRequestBody(v string) *Result
  • func (s *Result) SetRequestHeader(v string) *Result
  • func (s *Result) SetRequestQuery(v string) *Result
  • func (s *Result) SetResponseData(v string) *Result
  • func (s *Result) SetResponseHeader(v string) *Result
  • func (s *Result) SetResponseStatus(v int64) *Result
  • func (s *Result) SetScriptIdentifier(v string) *Result
  • func (s Result) String() string
• type Script
  • func New(p client.ConfigProvider, cfgs ...*nifcloud.Config) *Script
  • func (c *Script) ExecuteScript(input *ExecuteScriptInput) (*ExecuteScriptOutput, error)
  • func (c *Script) ExecuteScriptRequest(input *ExecuteScriptInput) (req *request.Request, output *ExecuteScriptOutput)
  • func (c *Script) ExecuteScriptWithContext(ctx nifcloud.Context, input *ExecuteScriptInput, opts ...request.Option) (*ExecuteScriptOutput, error)

Constants

const (
	ServiceName = "script"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Types

type ExecuteScriptInput

type ExecuteScriptInput struct {
	Body *string `locationName:"Body" type:"string"`

	Header *string `locationName:"Header" type:"string"`

	Method *string `locationName:"Method" type:"string"`

	Query *string `locationName:"Query" type:"string"`

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

func (ExecuteScriptInput) GoString

func (s ExecuteScriptInput) GoString() string

GoString returns the string representation

func (*ExecuteScriptInput) SetBody

func (s *ExecuteScriptInput) SetBody(v string) *ExecuteScriptInput

SetBody sets the Body field's value.

func (*ExecuteScriptInput) SetHeader

func (s *ExecuteScriptInput) SetHeader(v string) *ExecuteScriptInput

SetHeader sets the Header field's value.

func (*ExecuteScriptInput) SetMethod

func (s *ExecuteScriptInput) SetMethod(v string) *ExecuteScriptInput

SetMethod sets the Method field's value.

func (*ExecuteScriptInput) SetQuery

func (s *ExecuteScriptInput) SetQuery(v string) *ExecuteScriptInput

SetQuery sets the Query field's value.

func (*ExecuteScriptInput) SetScriptIdentifier

func (s *ExecuteScriptInput) SetScriptIdentifier(v string) *ExecuteScriptInput

SetScriptIdentifier sets the ScriptIdentifier field's value.

func (ExecuteScriptInput) String

func (s ExecuteScriptInput) String() string

String returns the string representation

type ExecuteScriptOutput

type ExecuteScriptOutput struct {
	Result *Result `type:"structure"`
	// contains filtered or unexported fields
}

func (ExecuteScriptOutput) GoString

func (s ExecuteScriptOutput) GoString() string

GoString returns the string representation

func (*ExecuteScriptOutput) SetResult

func (s *ExecuteScriptOutput) SetResult(v *Result) *ExecuteScriptOutput

SetResult sets the Result field's value.

func (ExecuteScriptOutput) String

func (s ExecuteScriptOutput) String() string

String returns the string representation

type Result

type Result struct {
	RequestBody *string `type:"string"`

	RequestHeader *string `type:"string"`

	RequestQuery *string `type:"string"`

	ResponseData *string `type:"string"`

	ResponseHeader *string `type:"string"`

	ResponseStatus *int64 `type:"integer"`

	ScriptIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (Result) GoString

func (s Result) GoString() string

GoString returns the string representation

func (*Result) SetRequestBody

func (s *Result) SetRequestBody(v string) *Result

SetRequestBody sets the RequestBody field's value.

func (*Result) SetRequestHeader

func (s *Result) SetRequestHeader(v string) *Result

SetRequestHeader sets the RequestHeader field's value.

func (*Result) SetRequestQuery

func (s *Result) SetRequestQuery(v string) *Result

SetRequestQuery sets the RequestQuery field's value.

func (*Result) SetResponseData

func (s *Result) SetResponseData(v string) *Result

SetResponseData sets the ResponseData field's value.

func (*Result) SetResponseHeader

func (s *Result) SetResponseHeader(v string) *Result

SetResponseHeader sets the ResponseHeader field's value.

func (*Result) SetResponseStatus

func (s *Result) SetResponseStatus(v int64) *Result

SetResponseStatus sets the ResponseStatus field's value.

func (*Result) SetScriptIdentifier

func (s *Result) SetScriptIdentifier(v string) *Result

SetScriptIdentifier sets the ScriptIdentifier field's value.

func (Result) String

func (s Result) String() string

String returns the string representation

type Script

type Script struct {
	*client.Client
}

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

Script 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 ...*nifcloud.Config) *Script

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

Example:

// Create a Script client from just a session.
svc := script.New(mySession)

// Create a Script client with additional configuration
svc := script.New(mySession, nifcloud.NewConfig().WithRegion("us-west-2"))

func (*Script) ExecuteScript

func (c *Script) ExecuteScript(input *ExecuteScriptInput) (*ExecuteScriptOutput, error)

ExecuteScript API operation for NIFCLOUD Script.

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 NIFCLOUD Script's API operation ExecuteScript for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/script-2015-09-01/ExecuteScript

func (*Script) ExecuteScriptRequest

func (c *Script) ExecuteScriptRequest(input *ExecuteScriptInput) (req *request.Request, output *ExecuteScriptOutput)

ExecuteScriptRequest generates a "nifcloud/request.Request" representing the client's request for the ExecuteScript operation. The "output" return value will be populated with the request's response once the request completes successfuly.

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 ExecuteScript for more information on using the ExecuteScript 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 ExecuteScriptRequest method.
req, resp := client.ExecuteScriptRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/script-2015-09-01/ExecuteScript

func (*Script) ExecuteScriptWithContext

func (c *Script) ExecuteScriptWithContext(ctx nifcloud.Context, input *ExecuteScriptInput, opts ...request.Option) (*ExecuteScriptOutput, error)

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

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