finspacedata

package
v1.40.2 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2021 License: Apache-2.0 Imports: 11 Imported by: 9

Documentation

Overview

Package finspacedata provides the client and types for making API requests to FinSpace Public API.

The FinSpace APIs let you take actions inside the FinSpace environment.

See https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13 for more information on this service.

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

Using the Client

To contact FinSpace Public API 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 FinSpace Public API client FinSpaceData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/finspacedata/#New

Index

Constants

View Source 
const (
	// ChangeTypeReplace is a ChangeType enum value
	ChangeTypeReplace = "REPLACE"

	// ChangeTypeAppend is a ChangeType enum value
	ChangeTypeAppend = "APPEND"

	// ChangeTypeModify is a ChangeType enum value
	ChangeTypeModify = "MODIFY"
)
View Source 
const (
	// ChangesetStatusPending is a ChangesetStatus enum value
	ChangesetStatusPending = "PENDING"

	// ChangesetStatusFailed is a ChangesetStatus enum value
	ChangesetStatusFailed = "FAILED"

	// ChangesetStatusSuccess is a ChangesetStatus enum value
	ChangesetStatusSuccess = "SUCCESS"

	// ChangesetStatusRunning is a ChangesetStatus enum value
	ChangesetStatusRunning = "RUNNING"

	// ChangesetStatusStopRequested is a ChangesetStatus enum value
	ChangesetStatusStopRequested = "STOP_REQUESTED"
)
View Source 
const (
	// ErrorCategoryTheInputsToThisRequestAreInvalid is a ErrorCategory enum value
	ErrorCategoryTheInputsToThisRequestAreInvalid = "The_inputs_to_this_request_are_invalid"

	// ErrorCategoryServiceLimitsHaveBeenExceeded is a ErrorCategory enum value
	ErrorCategoryServiceLimitsHaveBeenExceeded = "Service_limits_have_been_exceeded"

	// ErrorCategoryMissingRequiredPermissionToPerformThisRequest is a ErrorCategory enum value
	ErrorCategoryMissingRequiredPermissionToPerformThisRequest = "Missing_required_permission_to_perform_this_request"

	// ErrorCategoryOneOrMoreInputsToThisRequestWereNotFound is a ErrorCategory enum value
	ErrorCategoryOneOrMoreInputsToThisRequestWereNotFound = "One_or_more_inputs_to_this_request_were_not_found"

	// ErrorCategoryTheSystemTemporarilyLacksSufficientResourcesToProcessTheRequest is a ErrorCategory enum value
	ErrorCategoryTheSystemTemporarilyLacksSufficientResourcesToProcessTheRequest = "The_system_temporarily_lacks_sufficient_resources_to_process_the_request"

	// ErrorCategoryAnInternalErrorHasOccurred is a ErrorCategory enum value
	ErrorCategoryAnInternalErrorHasOccurred = "An_internal_error_has_occurred"

	// ErrorCategoryCancelled is a ErrorCategory enum value
	ErrorCategoryCancelled = "Cancelled"

	// ErrorCategoryAUserRecoverableErrorHasOccurred is a ErrorCategory enum value
	ErrorCategoryAUserRecoverableErrorHasOccurred = "A_user_recoverable_error_has_occurred"
)
View Source 
const (
	// FormatTypeCsv is a FormatType enum value
	FormatTypeCsv = "CSV"

	// FormatTypeJson is a FormatType enum value
	FormatTypeJson = "JSON"

	// FormatTypeParquet is a FormatType enum value
	FormatTypeParquet = "PARQUET"

	// FormatTypeXml is a FormatType enum value
	FormatTypeXml = "XML"
)
View Source 
const (
	// LocationTypeIngestion is a LocationType enum value
	LocationTypeIngestion = "INGESTION"

	// LocationTypeSagemaker is a LocationType enum value
	LocationTypeSagemaker = "SAGEMAKER"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request processing has failed because of an unknown error, exception
	// or failure.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// One or more resources can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "finspace data" // Name of service.
	EndpointsID = "finspace-api"  // ID to lookup a service endpoint with.
	ServiceID   = "finspace data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// SourceTypeS3 is a SourceType enum value
	SourceTypeS3 = "S3"
)

Variables

This section is empty.

Functions

func ChangeType_Values 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func ChangesetStatus_Values 

func ChangesetStatus_Values() []string

ChangesetStatus_Values returns all elements of the ChangesetStatus enum

func ErrorCategory_Values 

func ErrorCategory_Values() []string

ErrorCategory_Values returns all elements of the ErrorCategory enum

func FormatType_Values 

func FormatType_Values() []string

FormatType_Values returns all elements of the FormatType enum

func LocationType_Values 

func LocationType_Values() []string

LocationType_Values returns all elements of the LocationType enum

func SourceType_Values 

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

Types

type AccessDeniedException 

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

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

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation

type ChangesetInfo 

type ChangesetInfo struct {

	// Change type indicates how a changeset is applied to a dataset.
	//
	//    * REPLACE - Changeset is considered as a replacement to all prior loaded
	//    changesets.
	//
	//    * APPEND - Changeset is considered as an addition to the end of all prior
	//    loaded changesets.
	//
	//    * MODIFY - Changeset is considered as a replacement to a specific prior
	//    ingested changeset.
	ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"`

	// The ARN identifier of the changeset.
	ChangesetArn *string `locationName:"changesetArn" min:"20" type:"string"`

	// Tags associated with the changeset.
	ChangesetLabels map[string]*string `locationName:"changesetLabels" type:"map"`

	// The timestamp at which the changeset was created in FinSpace.
	CreateTimestamp *time.Time `locationName:"createTimestamp" type:"timestamp"`

	// The unique identifier for the FinSpace dataset in which the changeset is
	// created.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// The structure with error messages.
	ErrorInfo *ErrorInfo `locationName:"errorInfo" type:"structure"`

	// Structure of the source file(s).
	FormatParams map[string]*string `locationName:"formatParams" type:"map"`

	// Format type of the input files loaded into the changeset.
	FormatType *string `locationName:"formatType" type:"string" enum:"FormatType"`

	// Unique identifier for a changeset.
	Id *string `locationName:"id" min:"1" type:"string"`

	// Source path from which the files to create the changeset are sourced.
	SourceParams map[string]*string `locationName:"sourceParams" type:"map"`

	// Type of the data source from which the files to create the changeset are
	// sourced.
	//
	//    * S3 - Amazon S3.
	SourceType *string `locationName:"sourceType" type:"string" enum:"SourceType"`

	// The status of changeset creation operation.
	Status *string `locationName:"status" type:"string" enum:"ChangesetStatus"`

	// Unique identifier of the changeset that is updated a changeset.
	UpdatedByChangesetId *string `locationName:"updatedByChangesetId" type:"string"`

	// Unique identifier of the changeset that is updated.
	UpdatesChangesetId *string `locationName:"updatesChangesetId" type:"string"`
	// contains filtered or unexported fields
}

A changeset is unit of data in a dataset.

func (ChangesetInfo) GoString 

func (s ChangesetInfo) GoString() string

GoString returns the string representation

func (*ChangesetInfo) SetChangeType 

func (s *ChangesetInfo) SetChangeType(v string) *ChangesetInfo

SetChangeType sets the ChangeType field's value.

func (*ChangesetInfo) SetChangesetArn 

func (s *ChangesetInfo) SetChangesetArn(v string) *ChangesetInfo

SetChangesetArn sets the ChangesetArn field's value.

func (*ChangesetInfo) SetChangesetLabels 

func (s *ChangesetInfo) SetChangesetLabels(v map[string]*string) *ChangesetInfo

SetChangesetLabels sets the ChangesetLabels field's value.

func (*ChangesetInfo) SetCreateTimestamp 

func (s *ChangesetInfo) SetCreateTimestamp(v time.Time) *ChangesetInfo

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*ChangesetInfo) SetDatasetId 

func (s *ChangesetInfo) SetDatasetId(v string) *ChangesetInfo

SetDatasetId sets the DatasetId field's value.

func (*ChangesetInfo) SetErrorInfo 

func (s *ChangesetInfo) SetErrorInfo(v *ErrorInfo) *ChangesetInfo

SetErrorInfo sets the ErrorInfo field's value.

func (*ChangesetInfo) SetFormatParams 

func (s *ChangesetInfo) SetFormatParams(v map[string]*string) *ChangesetInfo

SetFormatParams sets the FormatParams field's value.

func (*ChangesetInfo) SetFormatType 

func (s *ChangesetInfo) SetFormatType(v string) *ChangesetInfo

SetFormatType sets the FormatType field's value.

func (*ChangesetInfo) SetId 

func (s *ChangesetInfo) SetId(v string) *ChangesetInfo

SetId sets the Id field's value.

func (*ChangesetInfo) SetSourceParams 

func (s *ChangesetInfo) SetSourceParams(v map[string]*string) *ChangesetInfo

SetSourceParams sets the SourceParams field's value.

func (*ChangesetInfo) SetSourceType 

func (s *ChangesetInfo) SetSourceType(v string) *ChangesetInfo

SetSourceType sets the SourceType field's value.

func (*ChangesetInfo) SetStatus 

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

SetStatus sets the Status field's value.

func (*ChangesetInfo) SetUpdatedByChangesetId 

func (s *ChangesetInfo) SetUpdatedByChangesetId(v string) *ChangesetInfo

SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value.

func (*ChangesetInfo) SetUpdatesChangesetId 

func (s *ChangesetInfo) SetUpdatesChangesetId(v string) *ChangesetInfo

SetUpdatesChangesetId sets the UpdatesChangesetId field's value.

func (ChangesetInfo) String 

func (s ChangesetInfo) String() string

String returns the string representation

type CreateChangesetInput 

type CreateChangesetInput struct {

	// Option to indicate how a changeset will be applied to a dataset.
	//
	//    * REPLACE - Changeset will be considered as a replacement to all prior
	//    loaded changesets.
	//
	//    * APPEND - Changeset will be considered as an addition to the end of all
	//    prior loaded changesets.
	//
	// ChangeType is a required field
	ChangeType *string `locationName:"changeType" type:"string" required:"true" enum:"ChangeType"`

	// The unique identifier for the FinSpace dataset in which the changeset will
	// be created.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// Options that define the structure of the source file(s).
	FormatParams map[string]*string `locationName:"formatParams" type:"map"`

	// Format type of the input files being loaded into the changeset.
	FormatType *string `locationName:"formatType" type:"string" enum:"FormatType"`

	// Source path from which the files to create the changeset will be sourced.
	//
	// SourceParams is a required field
	SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"`

	// Type of the data source from which the files to create the changeset will
	// be sourced.
	//
	//    * S3 - Amazon S3.
	//
	// SourceType is a required field
	SourceType *string `locationName:"sourceType" type:"string" required:"true" enum:"SourceType"`

	// Metadata tags to apply to this changeset.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateChangesetInput) GoString 

func (s CreateChangesetInput) GoString() string

GoString returns the string representation

func (*CreateChangesetInput) SetChangeType 

func (s *CreateChangesetInput) SetChangeType(v string) *CreateChangesetInput

SetChangeType sets the ChangeType field's value.

func (*CreateChangesetInput) SetDatasetId 

func (s *CreateChangesetInput) SetDatasetId(v string) *CreateChangesetInput

SetDatasetId sets the DatasetId field's value.

func (*CreateChangesetInput) SetFormatParams 

func (s *CreateChangesetInput) SetFormatParams(v map[string]*string) *CreateChangesetInput

SetFormatParams sets the FormatParams field's value.

func (*CreateChangesetInput) SetFormatType 

func (s *CreateChangesetInput) SetFormatType(v string) *CreateChangesetInput

SetFormatType sets the FormatType field's value.

func (*CreateChangesetInput) SetSourceParams 

func (s *CreateChangesetInput) SetSourceParams(v map[string]*string) *CreateChangesetInput

SetSourceParams sets the SourceParams field's value.

func (*CreateChangesetInput) SetSourceType 

func (s *CreateChangesetInput) SetSourceType(v string) *CreateChangesetInput

SetSourceType sets the SourceType field's value.

func (*CreateChangesetInput) SetTags 

func (s *CreateChangesetInput) SetTags(v map[string]*string) *CreateChangesetInput

SetTags sets the Tags field's value.

func (CreateChangesetInput) String 

func (s CreateChangesetInput) String() string

String returns the string representation

func (*CreateChangesetInput) Validate 

func (s *CreateChangesetInput) Validate() error

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

type CreateChangesetOutput 

type CreateChangesetOutput struct {

	// Returns the changeset details.
	Changeset *ChangesetInfo `locationName:"changeset" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateChangesetOutput) GoString 

func (s CreateChangesetOutput) GoString() string

GoString returns the string representation

func (*CreateChangesetOutput) SetChangeset 

func (s *CreateChangesetOutput) SetChangeset(v *ChangesetInfo) *CreateChangesetOutput

SetChangeset sets the Changeset field's value.

func (CreateChangesetOutput) String 

func (s CreateChangesetOutput) String() string

String returns the string representation

type Credentials 

type Credentials struct {

	// The access key identifier.
	AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"`

	// The access key.
	SecretAccessKey *string `locationName:"secretAccessKey" type:"string"`

	// The session token.
	SessionToken *string `locationName:"sessionToken" type:"string"`
	// contains filtered or unexported fields
}

Set short term API credentials.

func (Credentials) GoString 

func (s Credentials) GoString() string

GoString returns the string representation

func (*Credentials) SetAccessKeyId 

func (s *Credentials) SetAccessKeyId(v string) *Credentials

SetAccessKeyId sets the AccessKeyId field's value.

func (*Credentials) SetSecretAccessKey 

func (s *Credentials) SetSecretAccessKey(v string) *Credentials

SetSecretAccessKey sets the SecretAccessKey field's value.

func (*Credentials) SetSessionToken 

func (s *Credentials) SetSessionToken(v string) *Credentials

SetSessionToken sets the SessionToken field's value.

func (Credentials) String 

func (s Credentials) String() string

String returns the string representation

type ErrorInfo 

type ErrorInfo struct {

	// The category of the error.
	//
	//    * VALIDATION -The inputs to this request are invalid.
	//
	//    * SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact
	//    AWS support to increase quotas.
	//
	//    * ACCESS_DENIED - Missing required permission to perform this request.
	//
	//    * RESOURCE_NOT_FOUND - One or more inputs to this request were not found.
	//
	//    * THROTTLING - The system temporarily lacks sufficient resources to process
	//    the request.
	//
	//    * INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred.
	//
	//    * CANCELLED - A user recoverable error has occurred.
	ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"`

	// The text of the error message.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`
	// contains filtered or unexported fields
}

Error message.

func (ErrorInfo) GoString 

func (s ErrorInfo) GoString() string

GoString returns the string representation

func (*ErrorInfo) SetErrorCategory 

func (s *ErrorInfo) SetErrorCategory(v string) *ErrorInfo

SetErrorCategory sets the ErrorCategory field's value.

func (*ErrorInfo) SetErrorMessage 

func (s *ErrorInfo) SetErrorMessage(v string) *ErrorInfo

SetErrorMessage sets the ErrorMessage field's value.

func (ErrorInfo) String 

func (s ErrorInfo) String() string

String returns the string representation

type FinSpaceData 

type FinSpaceData struct {
	*client.Client
}

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

FinSpaceData 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) *FinSpaceData

New creates a new instance of the FinSpaceData 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 FinSpaceData client from just a session.
svc := finspacedata.New(mySession)

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

func (*FinSpaceData) CreateChangeset 

func (c *FinSpaceData) CreateChangeset(input *CreateChangesetInput) (*CreateChangesetOutput, error)

CreateChangeset API operation for FinSpace Public API.

Creates a new changeset in a FinSpace dataset.

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 FinSpace Public API's API operation CreateChangeset for usage and error information.

Returned Error Types:

  • ResourceNotFoundException One or more resources can't be found.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangeset

func (*FinSpaceData) CreateChangesetRequest 

func (c *FinSpaceData) CreateChangesetRequest(input *CreateChangesetInput) (req *request.Request, output *CreateChangesetOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangeset

func (*FinSpaceData) CreateChangesetWithContext 

func (c *FinSpaceData) CreateChangesetWithContext(ctx aws.Context, input *CreateChangesetInput, opts ...request.Option) (*CreateChangesetOutput, error)

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

See CreateChangeset 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 (*FinSpaceData) GetProgrammaticAccessCredentials 

func (c *FinSpaceData) GetProgrammaticAccessCredentials(input *GetProgrammaticAccessCredentialsInput) (*GetProgrammaticAccessCredentialsOutput, error)

GetProgrammaticAccessCredentials API operation for FinSpace Public API.

Request programmatic credentials to use with Habanero SDK.

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 FinSpace Public API's API operation GetProgrammaticAccessCredentials for usage and error information.

Returned Error Types:

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials

func (*FinSpaceData) GetProgrammaticAccessCredentialsRequest 

func (c *FinSpaceData) GetProgrammaticAccessCredentialsRequest(input *GetProgrammaticAccessCredentialsInput) (req *request.Request, output *GetProgrammaticAccessCredentialsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials

func (*FinSpaceData) GetProgrammaticAccessCredentialsWithContext 

func (c *FinSpaceData) GetProgrammaticAccessCredentialsWithContext(ctx aws.Context, input *GetProgrammaticAccessCredentialsInput, opts ...request.Option) (*GetProgrammaticAccessCredentialsOutput, error)

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

See GetProgrammaticAccessCredentials 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 (*FinSpaceData) GetWorkingLocation 

func (c *FinSpaceData) GetWorkingLocation(input *GetWorkingLocationInput) (*GetWorkingLocationOutput, error)

GetWorkingLocation API operation for FinSpace Public API.

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.

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 FinSpace Public API's API operation GetWorkingLocation for usage and error information.

Returned Error Types:

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation

func (*FinSpaceData) GetWorkingLocationRequest 

func (c *FinSpaceData) GetWorkingLocationRequest(input *GetWorkingLocationInput) (req *request.Request, output *GetWorkingLocationOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation

func (*FinSpaceData) GetWorkingLocationWithContext 

func (c *FinSpaceData) GetWorkingLocationWithContext(ctx aws.Context, input *GetWorkingLocationInput, opts ...request.Option) (*GetWorkingLocationOutput, error)

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

See GetWorkingLocation 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 GetProgrammaticAccessCredentialsInput 

type GetProgrammaticAccessCredentialsInput struct {

	// The time duration in which the credentials remain valid.
	DurationInMinutes *int64 `location:"querystring" locationName:"durationInMinutes" min:"60" type:"long"`

	// The habanero environment identifier.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `location:"querystring" locationName:"environmentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetProgrammaticAccessCredentialsInput) GoString 

func (s GetProgrammaticAccessCredentialsInput) GoString() string

GoString returns the string representation

func (*GetProgrammaticAccessCredentialsInput) SetDurationInMinutes 

func (s *GetProgrammaticAccessCredentialsInput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsInput

SetDurationInMinutes sets the DurationInMinutes field's value.

func (*GetProgrammaticAccessCredentialsInput) SetEnvironmentId 

func (s *GetProgrammaticAccessCredentialsInput) SetEnvironmentId(v string) *GetProgrammaticAccessCredentialsInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetProgrammaticAccessCredentialsInput) String 

func (s GetProgrammaticAccessCredentialsInput) String() string

String returns the string representation

func (*GetProgrammaticAccessCredentialsInput) Validate 

func (s *GetProgrammaticAccessCredentialsInput) Validate() error

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

type GetProgrammaticAccessCredentialsOutput 

type GetProgrammaticAccessCredentialsOutput struct {

	// Returns the programmatic credentials.
	Credentials *Credentials `locationName:"credentials" type:"structure"`

	// Returns the duration in which the credentials will remain valid.
	DurationInMinutes *int64 `locationName:"durationInMinutes" min:"60" type:"long"`
	// contains filtered or unexported fields
}

func (GetProgrammaticAccessCredentialsOutput) GoString 

func (s GetProgrammaticAccessCredentialsOutput) GoString() string

GoString returns the string representation

func (*GetProgrammaticAccessCredentialsOutput) SetCredentials 

func (s *GetProgrammaticAccessCredentialsOutput) SetCredentials(v *Credentials) *GetProgrammaticAccessCredentialsOutput

SetCredentials sets the Credentials field's value.

func (*GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes 

func (s *GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsOutput

SetDurationInMinutes sets the DurationInMinutes field's value.

func (GetProgrammaticAccessCredentialsOutput) String 

func (s GetProgrammaticAccessCredentialsOutput) String() string

String returns the string representation

type GetWorkingLocationInput 

type GetWorkingLocationInput struct {

	// Specify the type of the working location.
	//
	//    * SAGEMAKER - Use the Amazon S3 location as a temporary location to store
	//    data content when working with FinSpace Notebooks that run on SageMaker
	//    studio.
	//
	//    * INGESTION - Use the Amazon S3 location as a staging location to copy
	//    your data content and then use the location with the changeset creation
	//    operation.
	LocationType *string `locationName:"locationType" type:"string" enum:"LocationType"`
	// contains filtered or unexported fields
}

func (GetWorkingLocationInput) GoString 

func (s GetWorkingLocationInput) GoString() string

GoString returns the string representation

func (*GetWorkingLocationInput) SetLocationType 

func (s *GetWorkingLocationInput) SetLocationType(v string) *GetWorkingLocationInput

SetLocationType sets the LocationType field's value.

func (GetWorkingLocationInput) String 

func (s GetWorkingLocationInput) String() string

String returns the string representation

type GetWorkingLocationOutput 

type GetWorkingLocationOutput struct {

	// Returns the Amazon S3 bucket name for the working location.
	S3Bucket *string `locationName:"s3Bucket" min:"1" type:"string"`

	// Returns the Amazon S3 Path for the working location.
	S3Path *string `locationName:"s3Path" min:"1" type:"string"`

	// Returns the Amazon S3 URI for the working location.
	S3Uri *string `locationName:"s3Uri" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetWorkingLocationOutput) GoString 

func (s GetWorkingLocationOutput) GoString() string

GoString returns the string representation

func (*GetWorkingLocationOutput) SetS3Bucket 

func (s *GetWorkingLocationOutput) SetS3Bucket(v string) *GetWorkingLocationOutput

SetS3Bucket sets the S3Bucket field's value.

func (*GetWorkingLocationOutput) SetS3Path 

func (s *GetWorkingLocationOutput) SetS3Path(v string) *GetWorkingLocationOutput

SetS3Path sets the S3Path field's value.

func (*GetWorkingLocationOutput) SetS3Uri 

func (s *GetWorkingLocationOutput) SetS3Uri(v string) *GetWorkingLocationOutput

SetS3Uri sets the S3Uri field's value.

func (GetWorkingLocationOutput) String 

func (s GetWorkingLocationOutput) String() string

String returns the string representation

type InternalServerException 

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

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

The request processing has failed because of an unknown error, exception or failure.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation

type ResourceNotFoundException 

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

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

One or more resources can't be found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ThrottlingException 

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

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

The request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException 

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

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

The input fails to satisfy the constraints specified by an AWS service.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package finspacedataiface provides an interface to enable mocking the FinSpace Public API service client for testing your code.
 Package finspacedataiface provides an interface to enable mocking the FinSpace Public API 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.