Documentation
¶
Overview ¶
Package finspace provides the client and types for making API requests to FinSpace User Environment Management service.
The FinSpace management service provides the APIs for managing FinSpace environments.
See https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12 for more information on this service.
See finspace package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/finspace/
Using the Client ¶
To contact FinSpace User Environment Management service 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 User Environment Management service client Finspace for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/finspace/#New
Index ¶
- Constants
- func EnvironmentStatus_Values() []string
- func FederationMode_Values() []string
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type CreateEnvironmentInput
- func (s CreateEnvironmentInput) GoString() string
- func (s *CreateEnvironmentInput) SetDescription(v string) *CreateEnvironmentInput
- func (s *CreateEnvironmentInput) SetFederationMode(v string) *CreateEnvironmentInput
- func (s *CreateEnvironmentInput) SetFederationParameters(v *FederationParameters) *CreateEnvironmentInput
- func (s *CreateEnvironmentInput) SetKmsKeyId(v string) *CreateEnvironmentInput
- func (s *CreateEnvironmentInput) SetName(v string) *CreateEnvironmentInput
- func (s *CreateEnvironmentInput) SetTags(v map[string]*string) *CreateEnvironmentInput
- func (s CreateEnvironmentInput) String() string
- func (s *CreateEnvironmentInput) Validate() error
- type CreateEnvironmentOutput
- func (s CreateEnvironmentOutput) GoString() string
- func (s *CreateEnvironmentOutput) SetEnvironmentArn(v string) *CreateEnvironmentOutput
- func (s *CreateEnvironmentOutput) SetEnvironmentId(v string) *CreateEnvironmentOutput
- func (s *CreateEnvironmentOutput) SetEnvironmentUrl(v string) *CreateEnvironmentOutput
- func (s CreateEnvironmentOutput) String() string
- type DeleteEnvironmentInput
- type DeleteEnvironmentOutput
- type Environment
- func (s Environment) GoString() string
- func (s *Environment) SetAwsAccountId(v string) *Environment
- func (s *Environment) SetDedicatedServiceAccountId(v string) *Environment
- func (s *Environment) SetDescription(v string) *Environment
- func (s *Environment) SetEnvironmentArn(v string) *Environment
- func (s *Environment) SetEnvironmentId(v string) *Environment
- func (s *Environment) SetEnvironmentUrl(v string) *Environment
- func (s *Environment) SetFederationMode(v string) *Environment
- func (s *Environment) SetFederationParameters(v *FederationParameters) *Environment
- func (s *Environment) SetKmsKeyId(v string) *Environment
- func (s *Environment) SetName(v string) *Environment
- func (s *Environment) SetSageMakerStudioDomainUrl(v string) *Environment
- func (s *Environment) SetStatus(v string) *Environment
- func (s Environment) String() string
- type FederationParameters
- func (s FederationParameters) GoString() string
- func (s *FederationParameters) SetApplicationCallBackURL(v string) *FederationParameters
- func (s *FederationParameters) SetAttributeMap(v map[string]*string) *FederationParameters
- func (s *FederationParameters) SetFederationProviderName(v string) *FederationParameters
- func (s *FederationParameters) SetFederationURN(v string) *FederationParameters
- func (s *FederationParameters) SetSamlMetadataDocument(v string) *FederationParameters
- func (s *FederationParameters) SetSamlMetadataURL(v string) *FederationParameters
- func (s FederationParameters) String() string
- func (s *FederationParameters) Validate() error
- type Finspace
- func (c *Finspace) CreateEnvironment(input *CreateEnvironmentInput) (*CreateEnvironmentOutput, error)
- func (c *Finspace) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req *request.Request, output *CreateEnvironmentOutput)
- func (c *Finspace) CreateEnvironmentWithContext(ctx aws.Context, input *CreateEnvironmentInput, opts ...request.Option) (*CreateEnvironmentOutput, error)
- func (c *Finspace) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error)
- func (c *Finspace) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *request.Request, output *DeleteEnvironmentOutput)
- func (c *Finspace) DeleteEnvironmentWithContext(ctx aws.Context, input *DeleteEnvironmentInput, opts ...request.Option) (*DeleteEnvironmentOutput, error)
- func (c *Finspace) GetEnvironment(input *GetEnvironmentInput) (*GetEnvironmentOutput, error)
- func (c *Finspace) GetEnvironmentRequest(input *GetEnvironmentInput) (req *request.Request, output *GetEnvironmentOutput)
- func (c *Finspace) GetEnvironmentWithContext(ctx aws.Context, input *GetEnvironmentInput, opts ...request.Option) (*GetEnvironmentOutput, error)
- func (c *Finspace) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error)
- func (c *Finspace) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *request.Request, output *ListEnvironmentsOutput)
- func (c *Finspace) ListEnvironmentsWithContext(ctx aws.Context, input *ListEnvironmentsInput, opts ...request.Option) (*ListEnvironmentsOutput, error)
- func (c *Finspace) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *Finspace) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *Finspace) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *Finspace) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *Finspace) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *Finspace) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *Finspace) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *Finspace) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *Finspace) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- func (c *Finspace) UpdateEnvironment(input *UpdateEnvironmentInput) (*UpdateEnvironmentOutput, error)
- func (c *Finspace) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *request.Request, output *UpdateEnvironmentOutput)
- func (c *Finspace) UpdateEnvironmentWithContext(ctx aws.Context, input *UpdateEnvironmentInput, opts ...request.Option) (*UpdateEnvironmentOutput, error)
- type GetEnvironmentInput
- type GetEnvironmentOutput
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type InvalidRequestException
- func (s *InvalidRequestException) Code() string
- func (s *InvalidRequestException) Error() string
- func (s InvalidRequestException) GoString() string
- func (s *InvalidRequestException) Message() string
- func (s *InvalidRequestException) OrigErr() error
- func (s *InvalidRequestException) RequestID() string
- func (s *InvalidRequestException) StatusCode() int
- func (s InvalidRequestException) String() string
- type LimitExceededException
- func (s *LimitExceededException) Code() string
- func (s *LimitExceededException) Error() string
- func (s LimitExceededException) GoString() string
- func (s *LimitExceededException) Message() string
- func (s *LimitExceededException) OrigErr() error
- func (s *LimitExceededException) RequestID() string
- func (s *LimitExceededException) StatusCode() int
- func (s LimitExceededException) String() string
- type ListEnvironmentsInput
- func (s ListEnvironmentsInput) GoString() string
- func (s *ListEnvironmentsInput) SetMaxResults(v int64) *ListEnvironmentsInput
- func (s *ListEnvironmentsInput) SetNextToken(v string) *ListEnvironmentsInput
- func (s ListEnvironmentsInput) String() string
- func (s *ListEnvironmentsInput) Validate() error
- type ListEnvironmentsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type TagResourceInput
- type TagResourceOutput
- type ThrottlingException
- func (s *ThrottlingException) Code() string
- func (s *ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s *ThrottlingException) Message() string
- func (s *ThrottlingException) OrigErr() error
- func (s *ThrottlingException) RequestID() string
- func (s *ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateEnvironmentInput
- func (s UpdateEnvironmentInput) GoString() string
- func (s *UpdateEnvironmentInput) SetDescription(v string) *UpdateEnvironmentInput
- func (s *UpdateEnvironmentInput) SetEnvironmentId(v string) *UpdateEnvironmentInput
- func (s *UpdateEnvironmentInput) SetFederationMode(v string) *UpdateEnvironmentInput
- func (s *UpdateEnvironmentInput) SetFederationParameters(v *FederationParameters) *UpdateEnvironmentInput
- func (s *UpdateEnvironmentInput) SetName(v string) *UpdateEnvironmentInput
- func (s UpdateEnvironmentInput) String() string
- func (s *UpdateEnvironmentInput) Validate() error
- type UpdateEnvironmentOutput
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
Constants ¶
const ( // EnvironmentStatusCreateRequested is a EnvironmentStatus enum value EnvironmentStatusCreateRequested = "CREATE_REQUESTED" // EnvironmentStatusCreating is a EnvironmentStatus enum value EnvironmentStatusCreating = "CREATING" // EnvironmentStatusCreated is a EnvironmentStatus enum value EnvironmentStatusCreated = "CREATED" // EnvironmentStatusDeleteRequested is a EnvironmentStatus enum value EnvironmentStatusDeleteRequested = "DELETE_REQUESTED" // EnvironmentStatusDeleting is a EnvironmentStatus enum value EnvironmentStatusDeleting = "DELETING" // EnvironmentStatusDeleted is a EnvironmentStatus enum value EnvironmentStatusDeleted = "DELETED" // EnvironmentStatusFailedCreation is a EnvironmentStatus enum value EnvironmentStatusFailedCreation = "FAILED_CREATION" // EnvironmentStatusRetryDeletion is a EnvironmentStatus enum value EnvironmentStatusRetryDeletion = "RETRY_DELETION" // EnvironmentStatusFailedDeletion is a EnvironmentStatus enum value EnvironmentStatusFailedDeletion = "FAILED_DELETION" // EnvironmentStatusSuspended is a EnvironmentStatus enum value EnvironmentStatusSuspended = "SUSPENDED" )
const ( // FederationModeFederated is a FederationMode enum value FederationModeFederated = "FEDERATED" // FederationModeLocal is a FederationMode enum value FederationModeLocal = "LOCAL" )
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" // ErrCodeInvalidRequestException for service response error code // "InvalidRequestException". // // The request is invalid. Something is wrong with the input to the request. ErrCodeInvalidRequestException = "InvalidRequestException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // A service limit or quota is exceeded. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // One or more resources can't be found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // You have exceeded your service quota. To perform the requested action, remove // some of the relevant resources, or use Service Quotas to request a service // quota increase. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // 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" )
const ( ServiceName = "finspace" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "finspace" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func EnvironmentStatus_Values ¶
func EnvironmentStatus_Values() []string
EnvironmentStatus_Values returns all elements of the EnvironmentStatus enum
func FederationMode_Values ¶
func FederationMode_Values() []string
FederationMode_Values returns all elements of the FederationMode 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 CreateEnvironmentInput ¶
type CreateEnvironmentInput struct { // The description of the FinSpace environment to be created. Description *string `locationName:"description" min:"1" type:"string"` // Authentication mode for the environment. // // * FEDERATED - Users access FinSpace through Single Sign On (SSO) via your // Identity provider. // // * LOCAL - Users access FinSpace via email and password managed within // the FinSpace environment. FederationMode *string `locationName:"federationMode" type:"string" enum:"FederationMode"` // Configuration information when authentication mode is FEDERATED. FederationParameters *FederationParameters `locationName:"federationParameters" type:"structure"` // The KMS key id to encrypt your data in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the FinSpace environment to be created. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // Add tags to your FinSpace environment. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (CreateEnvironmentInput) GoString ¶
func (s CreateEnvironmentInput) GoString() string
GoString returns the string representation
func (*CreateEnvironmentInput) SetDescription ¶
func (s *CreateEnvironmentInput) SetDescription(v string) *CreateEnvironmentInput
SetDescription sets the Description field's value.
func (*CreateEnvironmentInput) SetFederationMode ¶
func (s *CreateEnvironmentInput) SetFederationMode(v string) *CreateEnvironmentInput
SetFederationMode sets the FederationMode field's value.
func (*CreateEnvironmentInput) SetFederationParameters ¶
func (s *CreateEnvironmentInput) SetFederationParameters(v *FederationParameters) *CreateEnvironmentInput
SetFederationParameters sets the FederationParameters field's value.
func (*CreateEnvironmentInput) SetKmsKeyId ¶
func (s *CreateEnvironmentInput) SetKmsKeyId(v string) *CreateEnvironmentInput
SetKmsKeyId sets the KmsKeyId field's value.
func (*CreateEnvironmentInput) SetName ¶
func (s *CreateEnvironmentInput) SetName(v string) *CreateEnvironmentInput
SetName sets the Name field's value.
func (*CreateEnvironmentInput) SetTags ¶
func (s *CreateEnvironmentInput) SetTags(v map[string]*string) *CreateEnvironmentInput
SetTags sets the Tags field's value.
func (CreateEnvironmentInput) String ¶
func (s CreateEnvironmentInput) String() string
String returns the string representation
func (*CreateEnvironmentInput) Validate ¶
func (s *CreateEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateEnvironmentOutput ¶
type CreateEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the FinSpace environment that you created. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // The unique identifier for FinSpace environment that you created. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The sign-in url for the web application of the FinSpace environment you created. EnvironmentUrl *string `locationName:"environmentUrl" min:"1" type:"string"` // contains filtered or unexported fields }
func (CreateEnvironmentOutput) GoString ¶
func (s CreateEnvironmentOutput) GoString() string
GoString returns the string representation
func (*CreateEnvironmentOutput) SetEnvironmentArn ¶
func (s *CreateEnvironmentOutput) SetEnvironmentArn(v string) *CreateEnvironmentOutput
SetEnvironmentArn sets the EnvironmentArn field's value.
func (*CreateEnvironmentOutput) SetEnvironmentId ¶
func (s *CreateEnvironmentOutput) SetEnvironmentId(v string) *CreateEnvironmentOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (*CreateEnvironmentOutput) SetEnvironmentUrl ¶
func (s *CreateEnvironmentOutput) SetEnvironmentUrl(v string) *CreateEnvironmentOutput
SetEnvironmentUrl sets the EnvironmentUrl field's value.
func (CreateEnvironmentOutput) String ¶
func (s CreateEnvironmentOutput) String() string
String returns the string representation
type DeleteEnvironmentInput ¶
type DeleteEnvironmentInput struct { // The identifier for the FinSpace environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteEnvironmentInput) GoString ¶
func (s DeleteEnvironmentInput) GoString() string
GoString returns the string representation
func (*DeleteEnvironmentInput) SetEnvironmentId ¶
func (s *DeleteEnvironmentInput) SetEnvironmentId(v string) *DeleteEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (DeleteEnvironmentInput) String ¶
func (s DeleteEnvironmentInput) String() string
String returns the string representation
func (*DeleteEnvironmentInput) Validate ¶
func (s *DeleteEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (DeleteEnvironmentOutput) GoString ¶
func (s DeleteEnvironmentOutput) GoString() string
GoString returns the string representation
func (DeleteEnvironmentOutput) String ¶
func (s DeleteEnvironmentOutput) String() string
String returns the string representation
type Environment ¶
type Environment struct { // The ID of the AWS account in which the FinSpace environment is created. AwsAccountId *string `locationName:"awsAccountId" min:"1" type:"string"` // The AWS account ID of the dedicated service account associated with your // FinSpace environment. DedicatedServiceAccountId *string `locationName:"dedicatedServiceAccountId" min:"1" type:"string"` // The description of the FinSpace environment. Description *string `locationName:"description" min:"1" type:"string"` // The Amazon Resource Name (ARN) of your FinSpace environment. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // The identifier of the FinSpace environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The sign-in url for the web application of your FinSpace environment. EnvironmentUrl *string `locationName:"environmentUrl" min:"1" type:"string"` // The authentication mode for the environment. FederationMode *string `locationName:"federationMode" type:"string" enum:"FederationMode"` // Configuration information when authentication mode is FEDERATED. FederationParameters *FederationParameters `locationName:"federationParameters" type:"structure"` // The KMS key id used to encrypt in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the FinSpace environment. Name *string `locationName:"name" min:"1" type:"string"` // The url of the integrated FinSpace notebook environment in your web application. SageMakerStudioDomainUrl *string `locationName:"sageMakerStudioDomainUrl" min:"1" type:"string"` // The current status of creation of the FinSpace environment. Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"` // contains filtered or unexported fields }
Represents an FinSpace environment.
func (Environment) GoString ¶
func (s Environment) GoString() string
GoString returns the string representation
func (*Environment) SetAwsAccountId ¶
func (s *Environment) SetAwsAccountId(v string) *Environment
SetAwsAccountId sets the AwsAccountId field's value.
func (*Environment) SetDedicatedServiceAccountId ¶
func (s *Environment) SetDedicatedServiceAccountId(v string) *Environment
SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.
func (*Environment) SetDescription ¶
func (s *Environment) SetDescription(v string) *Environment
SetDescription sets the Description field's value.
func (*Environment) SetEnvironmentArn ¶
func (s *Environment) SetEnvironmentArn(v string) *Environment
SetEnvironmentArn sets the EnvironmentArn field's value.
func (*Environment) SetEnvironmentId ¶
func (s *Environment) SetEnvironmentId(v string) *Environment
SetEnvironmentId sets the EnvironmentId field's value.
func (*Environment) SetEnvironmentUrl ¶
func (s *Environment) SetEnvironmentUrl(v string) *Environment
SetEnvironmentUrl sets the EnvironmentUrl field's value.
func (*Environment) SetFederationMode ¶
func (s *Environment) SetFederationMode(v string) *Environment
SetFederationMode sets the FederationMode field's value.
func (*Environment) SetFederationParameters ¶
func (s *Environment) SetFederationParameters(v *FederationParameters) *Environment
SetFederationParameters sets the FederationParameters field's value.
func (*Environment) SetKmsKeyId ¶
func (s *Environment) SetKmsKeyId(v string) *Environment
SetKmsKeyId sets the KmsKeyId field's value.
func (*Environment) SetName ¶
func (s *Environment) SetName(v string) *Environment
SetName sets the Name field's value.
func (*Environment) SetSageMakerStudioDomainUrl ¶
func (s *Environment) SetSageMakerStudioDomainUrl(v string) *Environment
SetSageMakerStudioDomainUrl sets the SageMakerStudioDomainUrl field's value.
func (*Environment) SetStatus ¶
func (s *Environment) SetStatus(v string) *Environment
SetStatus sets the Status field's value.
func (Environment) String ¶
func (s Environment) String() string
String returns the string representation
type FederationParameters ¶
type FederationParameters struct { // The redirect or sign-in URL that should be entered into the SAML 2.0 compliant // identity provider configuration (IdP). ApplicationCallBackURL *string `locationName:"applicationCallBackURL" min:"1" type:"string"` // SAML attribute name and value. The name must always be Email and the value // should be set to the attribute definition in which user email is set. For // example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. // Please check your SAML 2.0 compliant identity provider (IdP) documentation // for details. AttributeMap map[string]*string `locationName:"attributeMap" type:"map"` // Name of the identity provider (IdP). FederationProviderName *string `locationName:"federationProviderName" min:"1" type:"string"` // The Uniform Resource Name (URN). Also referred as Service Provider URN or // Audience URI or Service Provider Entity ID. FederationURN *string `locationName:"federationURN" min:"1" type:"string"` // SAML 2.0 Metadata document from identity provider (IdP). SamlMetadataDocument *string `locationName:"samlMetadataDocument" min:"1000" type:"string"` // Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP). SamlMetadataURL *string `locationName:"samlMetadataURL" min:"1" type:"string"` // contains filtered or unexported fields }
Configuration information when authentication mode is FEDERATED.
func (FederationParameters) GoString ¶
func (s FederationParameters) GoString() string
GoString returns the string representation
func (*FederationParameters) SetApplicationCallBackURL ¶
func (s *FederationParameters) SetApplicationCallBackURL(v string) *FederationParameters
SetApplicationCallBackURL sets the ApplicationCallBackURL field's value.
func (*FederationParameters) SetAttributeMap ¶
func (s *FederationParameters) SetAttributeMap(v map[string]*string) *FederationParameters
SetAttributeMap sets the AttributeMap field's value.
func (*FederationParameters) SetFederationProviderName ¶
func (s *FederationParameters) SetFederationProviderName(v string) *FederationParameters
SetFederationProviderName sets the FederationProviderName field's value.
func (*FederationParameters) SetFederationURN ¶
func (s *FederationParameters) SetFederationURN(v string) *FederationParameters
SetFederationURN sets the FederationURN field's value.
func (*FederationParameters) SetSamlMetadataDocument ¶
func (s *FederationParameters) SetSamlMetadataDocument(v string) *FederationParameters
SetSamlMetadataDocument sets the SamlMetadataDocument field's value.
func (*FederationParameters) SetSamlMetadataURL ¶
func (s *FederationParameters) SetSamlMetadataURL(v string) *FederationParameters
SetSamlMetadataURL sets the SamlMetadataURL field's value.
func (FederationParameters) String ¶
func (s FederationParameters) String() string
String returns the string representation
func (*FederationParameters) Validate ¶
func (s *FederationParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Finspace ¶
Finspace provides the API operation methods for making requests to FinSpace User Environment Management service. See this package's package overview docs for details on the service.
Finspace 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) *Finspace
New creates a new instance of the Finspace 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 Finspace client from just a session. svc := finspace.New(mySession) // Create a Finspace client with additional configuration svc := finspace.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Finspace) CreateEnvironment ¶
func (c *Finspace) CreateEnvironment(input *CreateEnvironmentInput) (*CreateEnvironmentOutput, error)
CreateEnvironment API operation for FinSpace User Environment Management service.
Create a new FinSpace environment.
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 User Environment Management service's API operation CreateEnvironment for usage and error information.
Returned Error Types:
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.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
LimitExceededException A service limit or quota is exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment
func (*Finspace) CreateEnvironmentRequest ¶
func (c *Finspace) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req *request.Request, output *CreateEnvironmentOutput)
CreateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateEnvironment 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 CreateEnvironment for more information on using the CreateEnvironment 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 CreateEnvironmentRequest method. req, resp := client.CreateEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment
func (*Finspace) CreateEnvironmentWithContext ¶
func (c *Finspace) CreateEnvironmentWithContext(ctx aws.Context, input *CreateEnvironmentInput, opts ...request.Option) (*CreateEnvironmentOutput, error)
CreateEnvironmentWithContext is the same as CreateEnvironment with the addition of the ability to pass a context and additional request options.
See CreateEnvironment 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 (*Finspace) DeleteEnvironment ¶
func (c *Finspace) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error)
DeleteEnvironment API operation for FinSpace User Environment Management service.
Delete an FinSpace environment.
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 User Environment Management service's API operation DeleteEnvironment 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.
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-2021-03-12/DeleteEnvironment
func (*Finspace) DeleteEnvironmentRequest ¶
func (c *Finspace) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *request.Request, output *DeleteEnvironmentOutput)
DeleteEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteEnvironment 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 DeleteEnvironment for more information on using the DeleteEnvironment 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 DeleteEnvironmentRequest method. req, resp := client.DeleteEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment
func (*Finspace) DeleteEnvironmentWithContext ¶
func (c *Finspace) DeleteEnvironmentWithContext(ctx aws.Context, input *DeleteEnvironmentInput, opts ...request.Option) (*DeleteEnvironmentOutput, error)
DeleteEnvironmentWithContext is the same as DeleteEnvironment with the addition of the ability to pass a context and additional request options.
See DeleteEnvironment 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 (*Finspace) GetEnvironment ¶
func (c *Finspace) GetEnvironment(input *GetEnvironmentInput) (*GetEnvironmentOutput, error)
GetEnvironment API operation for FinSpace User Environment Management service.
Returns the FinSpace environment object.
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 User Environment Management service's API operation GetEnvironment 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.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment
func (*Finspace) GetEnvironmentRequest ¶
func (c *Finspace) GetEnvironmentRequest(input *GetEnvironmentInput) (req *request.Request, output *GetEnvironmentOutput)
GetEnvironmentRequest generates a "aws/request.Request" representing the client's request for the GetEnvironment 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 GetEnvironment for more information on using the GetEnvironment 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 GetEnvironmentRequest method. req, resp := client.GetEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment
func (*Finspace) GetEnvironmentWithContext ¶
func (c *Finspace) GetEnvironmentWithContext(ctx aws.Context, input *GetEnvironmentInput, opts ...request.Option) (*GetEnvironmentOutput, error)
GetEnvironmentWithContext is the same as GetEnvironment with the addition of the ability to pass a context and additional request options.
See GetEnvironment 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 (*Finspace) ListEnvironments ¶
func (c *Finspace) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error)
ListEnvironments API operation for FinSpace User Environment Management service.
A list of all of your FinSpace environments.
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 User Environment Management service's API operation ListEnvironments for usage and error information.
Returned Error Types:
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments
func (*Finspace) ListEnvironmentsRequest ¶
func (c *Finspace) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *request.Request, output *ListEnvironmentsOutput)
ListEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ListEnvironments 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 ListEnvironments for more information on using the ListEnvironments 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 ListEnvironmentsRequest method. req, resp := client.ListEnvironmentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments
func (*Finspace) ListEnvironmentsWithContext ¶
func (c *Finspace) ListEnvironmentsWithContext(ctx aws.Context, input *ListEnvironmentsInput, opts ...request.Option) (*ListEnvironmentsOutput, error)
ListEnvironmentsWithContext is the same as ListEnvironments with the addition of the ability to pass a context and additional request options.
See ListEnvironments 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 (*Finspace) ListTagsForResource ¶
func (c *Finspace) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for FinSpace User Environment Management service.
A list of all tags for 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 FinSpace User Environment Management service's API operation ListTagsForResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource
func (*Finspace) ListTagsForResourceRequest ¶
func (c *Finspace) 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/finspace-2021-03-12/ListTagsForResource
func (*Finspace) ListTagsForResourceWithContext ¶
func (c *Finspace) 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 (*Finspace) TagResource ¶
func (c *Finspace) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for FinSpace User Environment Management service.
Adds metadata tags to a FinSpace 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 FinSpace User Environment Management service's API operation TagResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource
func (*Finspace) TagResourceRequest ¶
func (c *Finspace) 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/finspace-2021-03-12/TagResource
func (*Finspace) TagResourceWithContext ¶
func (c *Finspace) 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 (*Finspace) UntagResource ¶
func (c *Finspace) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for FinSpace User Environment Management service.
Removes metadata tags from a FinSpace 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 FinSpace User Environment Management service's API operation UntagResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource
func (*Finspace) UntagResourceRequest ¶
func (c *Finspace) 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/finspace-2021-03-12/UntagResource
func (*Finspace) UntagResourceWithContext ¶
func (c *Finspace) 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.
func (*Finspace) UpdateEnvironment ¶
func (c *Finspace) UpdateEnvironment(input *UpdateEnvironmentInput) (*UpdateEnvironmentOutput, error)
UpdateEnvironment API operation for FinSpace User Environment Management service.
Update your FinSpace environment.
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 User Environment Management service's API operation UpdateEnvironment 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.
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-2021-03-12/UpdateEnvironment
func (*Finspace) UpdateEnvironmentRequest ¶
func (c *Finspace) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *request.Request, output *UpdateEnvironmentOutput)
UpdateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateEnvironment 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 UpdateEnvironment for more information on using the UpdateEnvironment 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 UpdateEnvironmentRequest method. req, resp := client.UpdateEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateEnvironment
func (*Finspace) UpdateEnvironmentWithContext ¶
func (c *Finspace) UpdateEnvironmentWithContext(ctx aws.Context, input *UpdateEnvironmentInput, opts ...request.Option) (*UpdateEnvironmentOutput, error)
UpdateEnvironmentWithContext is the same as UpdateEnvironment with the addition of the ability to pass a context and additional request options.
See UpdateEnvironment 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 GetEnvironmentInput ¶
type GetEnvironmentInput struct { // The identifier of the FinSpace environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetEnvironmentInput) GoString ¶
func (s GetEnvironmentInput) GoString() string
GoString returns the string representation
func (*GetEnvironmentInput) SetEnvironmentId ¶
func (s *GetEnvironmentInput) SetEnvironmentId(v string) *GetEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (GetEnvironmentInput) String ¶
func (s GetEnvironmentInput) String() string
String returns the string representation
func (*GetEnvironmentInput) Validate ¶
func (s *GetEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEnvironmentOutput ¶
type GetEnvironmentOutput struct { // The name of the FinSpace environment. Environment *Environment `locationName:"environment" type:"structure"` // contains filtered or unexported fields }
func (GetEnvironmentOutput) GoString ¶
func (s GetEnvironmentOutput) GoString() string
GoString returns the string representation
func (*GetEnvironmentOutput) SetEnvironment ¶
func (s *GetEnvironmentOutput) SetEnvironment(v *Environment) *GetEnvironmentOutput
SetEnvironment sets the Environment field's value.
func (GetEnvironmentOutput) String ¶
func (s GetEnvironmentOutput) 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 InvalidRequestException ¶
type InvalidRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request is invalid. Something is wrong with the input to the request.
func (*InvalidRequestException) Code ¶
func (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (*InvalidRequestException) Error ¶
func (s *InvalidRequestException) Error() string
func (InvalidRequestException) GoString ¶
func (s InvalidRequestException) GoString() string
GoString returns the string representation
func (*InvalidRequestException) Message ¶
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (*InvalidRequestException) OrigErr ¶
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InvalidRequestException) RequestID ¶
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InvalidRequestException) StatusCode ¶
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InvalidRequestException) String ¶
func (s InvalidRequestException) String() string
String returns the string representation
type LimitExceededException ¶
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
A service limit or quota is exceeded.
func (*LimitExceededException) Code ¶
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (*LimitExceededException) Error ¶
func (s *LimitExceededException) Error() string
func (LimitExceededException) GoString ¶
func (s LimitExceededException) GoString() string
GoString returns the string representation
func (*LimitExceededException) Message ¶
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (*LimitExceededException) OrigErr ¶
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*LimitExceededException) RequestID ¶
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*LimitExceededException) StatusCode ¶
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (LimitExceededException) String ¶
func (s LimitExceededException) String() string
String returns the string representation
type ListEnvironmentsInput ¶
type ListEnvironmentsInput struct { // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token generated by FinSpace that specifies where to continue pagination // if a previous request was truncated. To get the next set of pages, pass in // the nextToken value from the response object of the previous page call. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListEnvironmentsInput) GoString ¶
func (s ListEnvironmentsInput) GoString() string
GoString returns the string representation
func (*ListEnvironmentsInput) SetMaxResults ¶
func (s *ListEnvironmentsInput) SetMaxResults(v int64) *ListEnvironmentsInput
SetMaxResults sets the MaxResults field's value.
func (*ListEnvironmentsInput) SetNextToken ¶
func (s *ListEnvironmentsInput) SetNextToken(v string) *ListEnvironmentsInput
SetNextToken sets the NextToken field's value.
func (ListEnvironmentsInput) String ¶
func (s ListEnvironmentsInput) String() string
String returns the string representation
func (*ListEnvironmentsInput) Validate ¶
func (s *ListEnvironmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListEnvironmentsOutput ¶
type ListEnvironmentsOutput struct { // A list of all of your FinSpace environments. Environments []*Environment `locationName:"environments" type:"list"` // A token that you can use in a subsequent call to retrieve the next set of // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListEnvironmentsOutput) GoString ¶
func (s ListEnvironmentsOutput) GoString() string
GoString returns the string representation
func (*ListEnvironmentsOutput) SetEnvironments ¶
func (s *ListEnvironmentsOutput) SetEnvironments(v []*Environment) *ListEnvironmentsOutput
SetEnvironments sets the Environments field's value.
func (*ListEnvironmentsOutput) SetNextToken ¶
func (s *ListEnvironmentsOutput) SetNextToken(v string) *ListEnvironmentsOutput
SetNextToken sets the NextToken field's value.
func (ListEnvironmentsOutput) String ¶
func (s ListEnvironmentsOutput) String() string
String returns the string representation
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" 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 { // A list of all tags for a resource. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // 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 map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) 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 ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
func (*ServiceQuotaExceededException) Code ¶
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (*ServiceQuotaExceededException) Error ¶
func (s *ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation
func (*ServiceQuotaExceededException) Message ¶
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (*ServiceQuotaExceededException) OrigErr ¶
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ServiceQuotaExceededException) RequestID ¶
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ServiceQuotaExceededException) StatusCode ¶
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶
func (s ServiceQuotaExceededException) String() string
String returns the string representation
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) for the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // One or more tags to be assigned to the resource. // // Tags is a required field Tags map[string]*string `locationName:"tags" min:"1" type:"map" 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 map[string]*string) *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 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 UntagResourceInput ¶
type UntagResourceInput struct { // A FinSpace resource from which you want to remove a tag or tags. The value // for this parameter is an Amazon Resource Name (ARN). // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // The tag keys (names) of one or more tags to be removed. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" 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
type UpdateEnvironmentInput ¶
type UpdateEnvironmentInput struct { // The description of the environment. Description *string `locationName:"description" min:"1" type:"string"` // The identifier of the FinSpace environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // Authentication mode for the environment. // // * FEDERATED - Users access FinSpace through Single Sign On (SSO) via your // Identity provider. // // * LOCAL - Users access FinSpace via email and password managed within // the FinSpace environment. FederationMode *string `locationName:"federationMode" type:"string" enum:"FederationMode"` // Configuration information when authentication mode is FEDERATED. FederationParameters *FederationParameters `locationName:"federationParameters" type:"structure"` // The name of the environment. Name *string `locationName:"name" min:"1" type:"string"` // contains filtered or unexported fields }
func (UpdateEnvironmentInput) GoString ¶
func (s UpdateEnvironmentInput) GoString() string
GoString returns the string representation
func (*UpdateEnvironmentInput) SetDescription ¶
func (s *UpdateEnvironmentInput) SetDescription(v string) *UpdateEnvironmentInput
SetDescription sets the Description field's value.
func (*UpdateEnvironmentInput) SetEnvironmentId ¶
func (s *UpdateEnvironmentInput) SetEnvironmentId(v string) *UpdateEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (*UpdateEnvironmentInput) SetFederationMode ¶
func (s *UpdateEnvironmentInput) SetFederationMode(v string) *UpdateEnvironmentInput
SetFederationMode sets the FederationMode field's value.
func (*UpdateEnvironmentInput) SetFederationParameters ¶
func (s *UpdateEnvironmentInput) SetFederationParameters(v *FederationParameters) *UpdateEnvironmentInput
SetFederationParameters sets the FederationParameters field's value.
func (*UpdateEnvironmentInput) SetName ¶
func (s *UpdateEnvironmentInput) SetName(v string) *UpdateEnvironmentInput
SetName sets the Name field's value.
func (UpdateEnvironmentInput) String ¶
func (s UpdateEnvironmentInput) String() string
String returns the string representation
func (*UpdateEnvironmentInput) Validate ¶
func (s *UpdateEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput struct { // Returns the FinSpace environment object. Environment *Environment `locationName:"environment" type:"structure"` // contains filtered or unexported fields }
func (UpdateEnvironmentOutput) GoString ¶
func (s UpdateEnvironmentOutput) GoString() string
GoString returns the string representation
func (*UpdateEnvironmentOutput) SetEnvironment ¶
func (s *UpdateEnvironmentOutput) SetEnvironment(v *Environment) *UpdateEnvironmentOutput
SetEnvironment sets the Environment field's value.
func (UpdateEnvironmentOutput) String ¶
func (s UpdateEnvironmentOutput) 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
Directories
¶
Path | Synopsis |
---|---|
Package finspaceiface provides an interface to enable mocking the FinSpace User Environment Management service service client for testing your code.
|
Package finspaceiface provides an interface to enable mocking the FinSpace User Environment Management service service client for testing your code. |