fsx

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2019 License: Apache-2.0 Imports: 6 Imported by: 38

Documentation

Overview

Package fsx provides the client and types for making API requests to Amazon FSx.

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

See https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01 for more information on this service.

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

Using the Client

To Amazon FSx 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 Amazon FSx client FSx for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/#New

Index

Examples

Constants

View Source 
const (

	// ErrCodeActiveDirectoryError for service response error code
	// "ActiveDirectoryError".
	//
	// An Active Directory error.
	ErrCodeActiveDirectoryError = "ActiveDirectoryError"

	// ErrCodeBackupInProgress for service response error code
	// "BackupInProgress".
	//
	// Another backup is already under way. Wait for completion before initiating
	// additional backups of this file system.
	ErrCodeBackupInProgress = "BackupInProgress"

	// ErrCodeBackupNotFound for service response error code
	// "BackupNotFound".
	//
	// No Amazon FSx backups were found based upon the supplied parameters.
	ErrCodeBackupNotFound = "BackupNotFound"

	// ErrCodeBackupRestoring for service response error code
	// "BackupRestoring".
	//
	// You can't delete a backup while it's being used to restore a file system.
	ErrCodeBackupRestoring = "BackupRestoring"

	// ErrCodeBadRequest for service response error code
	// "BadRequest".
	//
	// A generic error indicating a failure with a client request.
	ErrCodeBadRequest = "BadRequest"

	// ErrCodeFileSystemNotFound for service response error code
	// "FileSystemNotFound".
	//
	// No Amazon FSx file systems were found based upon supplied parameters.
	ErrCodeFileSystemNotFound = "FileSystemNotFound"

	// ErrCodeIncompatibleParameterError for service response error code
	// "IncompatibleParameterError".
	//
	// The error returned when a second request is received with the same client
	// request token but different parameters settings. A client request token should
	// always uniquely identify a single request.
	ErrCodeIncompatibleParameterError = "IncompatibleParameterError"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// A generic error indicating a server-side failure.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidImportPath for service response error code
	// "InvalidImportPath".
	//
	// The path provided for data repository import isn't valid.
	ErrCodeInvalidImportPath = "InvalidImportPath"

	// ErrCodeInvalidNetworkSettings for service response error code
	// "InvalidNetworkSettings".
	//
	// One or more network settings specified in the request are invalid. InvalidVpcId
	// means that the ID passed for the virtual private cloud (VPC) is invalid.
	// InvalidSubnetIds returns the list of IDs for subnets that are either invalid
	// or not part of the VPC specified. InvalidSecurityGroupIds returns the list
	// of IDs for security groups that are either invalid or not part of the VPC
	// specified.
	ErrCodeInvalidNetworkSettings = "InvalidNetworkSettings"

	// ErrCodeMissingFileSystemConfiguration for service response error code
	// "MissingFileSystemConfiguration".
	//
	// File system configuration is required for this operation.
	ErrCodeMissingFileSystemConfiguration = "MissingFileSystemConfiguration"

	// ErrCodeNotServiceResourceError for service response error code
	// "NotServiceResourceError".
	//
	// The resource specified for the tagging operation is not a resource type owned
	// by Amazon FSx. Use the API of the relevant service to perform the operation.
	ErrCodeNotServiceResourceError = "NotServiceResourceError"

	// ErrCodeResourceDoesNotSupportTagging for service response error code
	// "ResourceDoesNotSupportTagging".
	//
	// The resource specified does not support tagging.
	ErrCodeResourceDoesNotSupportTagging = "ResourceDoesNotSupportTagging"

	// ErrCodeResourceNotFound for service response error code
	// "ResourceNotFound".
	//
	// The resource specified by the Amazon Resource Name (ARN) can't be found.
	ErrCodeResourceNotFound = "ResourceNotFound"

	// ErrCodeServiceLimitExceeded for service response error code
	// "ServiceLimitExceeded".
	//
	// An error indicating that a particular service limit was exceeded. You can
	// increase some service limits by contacting AWS Support.
	ErrCodeServiceLimitExceeded = "ServiceLimitExceeded"
)
View Source 
const (
	ServiceName = "fsx"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveDirectoryErrorType 

type ActiveDirectoryErrorType string

The type of error relating to Microsoft Active Directory. NOT_FOUND means that no directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified directory isn't accessible from the specified VPC. WRONG_STAGE means that the specified directory isn't currently in the ACTIVE state. 

const (
	ActiveDirectoryErrorTypeDomainNotFound         ActiveDirectoryErrorType = "DOMAIN_NOT_FOUND"
	ActiveDirectoryErrorTypeIncompatibleDomainMode ActiveDirectoryErrorType = "INCOMPATIBLE_DOMAIN_MODE"
	ActiveDirectoryErrorTypeWrongVpc               ActiveDirectoryErrorType = "WRONG_VPC"
	ActiveDirectoryErrorTypeInvalidDomainStage     ActiveDirectoryErrorType = "INVALID_DOMAIN_STAGE"
)

Enum values for ActiveDirectoryErrorType

func (ActiveDirectoryErrorType) MarshalValue 

func (enum ActiveDirectoryErrorType) MarshalValue() (string, error)

func (ActiveDirectoryErrorType) MarshalValueBuf 

func (enum ActiveDirectoryErrorType) MarshalValueBuf(b []byte) ([]byte, error)

type Backup 

type Backup struct {

	// The ID of the backup.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// The time when a particular backup was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

	// Details explaining any failures that occur when creating a backup.
	FailureDetails *BackupFailureDetails `type:"structure"`

	// Metadata of the file system associated with the backup. This metadata is
	// persisted even if the file system is deleted.
	//
	// FileSystem is a required field
	FileSystem *FileSystem `type:"structure" required:"true"`

	// The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this
	// backup's data.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle status of the backup.
	//
	// Lifecycle is a required field
	Lifecycle BackupLifecycle `type:"string" required:"true" enum:"true"`

	// The current percent of progress of an asynchronous task.
	ProgressPercent *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) for the backup resource.
	ResourceARN *string `min:"8" type:"string"`

	// Tags associated with a particular file system.
	Tags []Tag `min:"1" type:"list"`

	// The type of the backup.
	//
	// Type is a required field
	Type BackupType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup

func (Backup) GoString 

func (s Backup) GoString() string

GoString returns the string representation

func (Backup) String 

func (s Backup) String() string

String returns the string representation

type BackupFailureDetails 

type BackupFailureDetails struct {

	// A message describing the backup creation failure.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

If backup creation fails, this structure contains the details of that failure. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupFailureDetails

func (BackupFailureDetails) GoString 

func (s BackupFailureDetails) GoString() string

GoString returns the string representation

func (BackupFailureDetails) String 

func (s BackupFailureDetails) String() string

String returns the string representation

type BackupLifecycle 

type BackupLifecycle string

The lifecycle status of the backup. 

const (
	BackupLifecycleAvailable BackupLifecycle = "AVAILABLE"
	BackupLifecycleCreating  BackupLifecycle = "CREATING"
	BackupLifecycleDeleted   BackupLifecycle = "DELETED"
	BackupLifecycleFailed    BackupLifecycle = "FAILED"
)

Enum values for BackupLifecycle

func (BackupLifecycle) MarshalValue 

func (enum BackupLifecycle) MarshalValue() (string, error)

func (BackupLifecycle) MarshalValueBuf 

func (enum BackupLifecycle) MarshalValueBuf(b []byte) ([]byte, error)

type BackupType 

type BackupType string

The type of the backup. 

const (
	BackupTypeAutomatic     BackupType = "AUTOMATIC"
	BackupTypeUserInitiated BackupType = "USER_INITIATED"
)

Enum values for BackupType

func (BackupType) MarshalValue 

func (enum BackupType) MarshalValue() (string, error)

func (BackupType) MarshalValueBuf 

func (enum BackupType) MarshalValueBuf(b []byte) ([]byte, error)

type CreateBackupInput 

type CreateBackupInput struct {

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent creation. This string is automatically filled on your behalf
	// when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the file system to back up.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The tags to apply to the backup at backup creation. The key value of the
	// Name tag appears in the console as the backup name.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The request object for the CreateBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupRequest

func (CreateBackupInput) GoString 

func (s CreateBackupInput) GoString() string

GoString returns the string representation

func (CreateBackupInput) String 

func (s CreateBackupInput) String() string

String returns the string representation

func (*CreateBackupInput) Validate 

func (s *CreateBackupInput) Validate() error

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

type CreateBackupOutput 

type CreateBackupOutput struct {

	// A description of the backup.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the CreateBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupResponse

func (CreateBackupOutput) GoString 

func (s CreateBackupOutput) GoString() string

GoString returns the string representation

func (CreateBackupOutput) SDKResponseMetadata 

func (s CreateBackupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateBackupOutput) String 

func (s CreateBackupOutput) String() string

String returns the string representation

type CreateBackupRequest 

type CreateBackupRequest struct {
	*aws.Request
	Input *CreateBackupInput
	Copy  func(*CreateBackupInput) CreateBackupRequest
}

CreateBackupRequest is a API request type for the CreateBackup API operation.

func (CreateBackupRequest) Send 

func (r CreateBackupRequest) Send() (*CreateBackupOutput, error)

Send marshals and sends the CreateBackup API request.

type CreateFileSystemFromBackupInput 

type CreateFileSystemFromBackupInput struct {

	// The ID of the backup.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent creation. This string is automatically filled on your behalf
	// when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A list of IDs for the security groups that apply to the specified network
	// interfaces created for file system access. These security groups apply to
	// all network interfaces. This value isn't returned in later describe requests.
	SecurityGroupIds []string `type:"list"`

	// A list of IDs for the subnets that the file system will be accessible from.
	// Currently, you can specify only one subnet. The file server is also launched
	// in that subnet's Availability Zone.
	//
	// SubnetIds is a required field
	SubnetIds []string `type:"list" required:"true"`

	// The tags to be applied to the file system at file system creation. The key
	// value of the Name tag appears in the console as the file system name.
	Tags []Tag `min:"1" type:"list"`

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for the CreateFileSystemFromBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest

func (CreateFileSystemFromBackupInput) GoString 

func (s CreateFileSystemFromBackupInput) GoString() string

GoString returns the string representation

func (CreateFileSystemFromBackupInput) String 

func (s CreateFileSystemFromBackupInput) String() string

String returns the string representation

func (*CreateFileSystemFromBackupInput) Validate 

func (s *CreateFileSystemFromBackupInput) Validate() error

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

type CreateFileSystemFromBackupOutput 

type CreateFileSystemFromBackupOutput struct {

	// A description of the file system.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the CreateFileSystemFromBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupResponse

func (CreateFileSystemFromBackupOutput) GoString 

func (s CreateFileSystemFromBackupOutput) GoString() string

GoString returns the string representation

func (CreateFileSystemFromBackupOutput) SDKResponseMetadata 

func (s CreateFileSystemFromBackupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateFileSystemFromBackupOutput) String 

func (s CreateFileSystemFromBackupOutput) String() string

String returns the string representation

type CreateFileSystemFromBackupRequest 

type CreateFileSystemFromBackupRequest struct {
	*aws.Request
	Input *CreateFileSystemFromBackupInput
	Copy  func(*CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest
}

CreateFileSystemFromBackupRequest is a API request type for the CreateFileSystemFromBackup API operation.

func (CreateFileSystemFromBackupRequest) Send 

func (r CreateFileSystemFromBackupRequest) Send() (*CreateFileSystemFromBackupOutput, error)

Send marshals and sends the CreateFileSystemFromBackup API request.

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent creation. This string is automatically filled on your behalf
	// when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The type of file system.
	//
	// FileSystemType is a required field
	FileSystemType FileSystemType `type:"string" required:"true" enum:"true"`

	// The ID of your AWS Key Management Service (AWS KMS) key. This ID is used
	// to encrypt the data in your file system at rest. For more information, see
	// Encrypt (http://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html)
	// in the AWS Key Management Service API Reference.
	KmsKeyId *string `min:"1" type:"string"`

	// The configuration object for Lustre file systems used in the CreateFileSystem
	// operation.
	LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"`

	// A list of IDs for the security groups that apply to the specified network
	// interfaces created for file system access. These security groups will apply
	// to all network interfaces. This list isn't returned in later describe requests.
	SecurityGroupIds []string `type:"list"`

	// The storage capacity of the file system.
	//
	// For Windows file systems, the storage capacity has a minimum of 300 GiB,
	// and a maximum of 65,536 GiB.
	//
	// For Lustre file systems, the storage capacity has a minimum of 3,600 GiB.
	// Storage capacity is provisioned in increments of 3,600 GiB.
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `min:"300" type:"integer" required:"true"`

	// A list of IDs for the subnets that the file system will be accessible from.
	// File systems support only one subnet. The file server is also launched in
	// that subnet's Availability Zone.
	//
	// SubnetIds is a required field
	SubnetIds []string `type:"list" required:"true"`

	// The tags to be applied to the file system at file system creation. The key
	// value of the Name tag appears in the console as the file system name.
	Tags []Tag `min:"1" type:"list"`

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for the CreateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest

func (CreateFileSystemInput) GoString 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation

func (CreateFileSystemInput) String 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate 

func (s *CreateFileSystemInput) Validate() error

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

type CreateFileSystemLustreConfiguration 

type CreateFileSystemLustreConfiguration struct {

	// (Optional) The path to the Amazon S3 bucket (and optional prefix) that you're
	// using as the data repository for your FSx for Lustre file system, for example
	// s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon
	// S3 bucket name, only object keys with that prefix are loaded into the file
	// system.
	ImportPath *string `min:"3" type:"string"`

	// (Optional) For files imported from a data repository, this value determines
	// the stripe count and maximum amount of data per file (in MiB) stored on a
	// single physical disk. The maximum number of disks that a single file can
	// be striped across is limited by the total number of disks that make up the
	// file system.
	//
	// The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000
	// MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
	ImportedFileChunkSize *int64 `min:"1" type:"integer"`

	// The preferred time to perform weekly maintenance, in the UTC time zone.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for Lustre file systems used in the CreateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemLustreConfiguration

func (CreateFileSystemLustreConfiguration) GoString 

func (s CreateFileSystemLustreConfiguration) GoString() string

GoString returns the string representation

func (CreateFileSystemLustreConfiguration) String 

func (s CreateFileSystemLustreConfiguration) String() string

String returns the string representation

func (*CreateFileSystemLustreConfiguration) Validate 

func (s *CreateFileSystemLustreConfiguration) Validate() error

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

type CreateFileSystemOutput 

type CreateFileSystemOutput struct {

	// A description of the file system.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the CreateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemResponse

func (CreateFileSystemOutput) GoString 

func (s CreateFileSystemOutput) GoString() string

GoString returns the string representation

func (CreateFileSystemOutput) SDKResponseMetadata 

func (s CreateFileSystemOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateFileSystemOutput) String 

func (s CreateFileSystemOutput) String() string

String returns the string representation

type CreateFileSystemRequest 

type CreateFileSystemRequest struct {
	*aws.Request
	Input *CreateFileSystemInput
	Copy  func(*CreateFileSystemInput) CreateFileSystemRequest
}

CreateFileSystemRequest is a API request type for the CreateFileSystem API operation.

func (CreateFileSystemRequest) Send 

func (r CreateFileSystemRequest) Send() (*CreateFileSystemOutput, error)

Send marshals and sends the CreateFileSystem API request.

type CreateFileSystemWindowsConfiguration 

type CreateFileSystemWindowsConfiguration struct {

	// The ID for an existing Microsoft Active Directory instance that the file
	// system should join when it's created.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// The number of days to retain automatic backups. The default is to retain
	// backups for 7 days. Setting this value to 0 disables the creation of automatic
	// backups. The maximum retention period for backups is 35 days.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

	// A boolean flag indicating whether tags on the file system should be copied
	// to backups. This value defaults to false. If it's set to true, all tags on
	// the file system are copied to all automatic backups and any user-initiated
	// backups where the user doesn't specify any tags. If this value is true, and
	// you specify one or more tags, only the specified tags are copied to backups.
	CopyTagsToBackups *bool `type:"boolean"`

	// The preferred time to take daily automatic backups, in the UTC time zone.
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// The throughput of an Amazon FSx file system, measured in megabytes per second.
	//
	// ThroughputCapacity is a required field
	ThroughputCapacity *int64 `min:"8" type:"integer" required:"true"`

	// The preferred start time to perform weekly maintenance, in the UTC time zone.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration

func (CreateFileSystemWindowsConfiguration) GoString 

func (s CreateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (CreateFileSystemWindowsConfiguration) String 

func (s CreateFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*CreateFileSystemWindowsConfiguration) Validate 

func (s *CreateFileSystemWindowsConfiguration) Validate() error

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

type DataRepositoryConfiguration 

type DataRepositoryConfiguration struct {

	// The Amazon S3 commit path to use for storing new and changed Lustre file
	// system files as part of the archive operation from the file system to Amazon
	// S3. The value is s3://import-bucket/FSxLustre[creationtimestamp]. The timestamp
	// is presented in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
	// Files are archived to a different prefix in the Amazon S3 bucket, preventing
	// input data from being overwritten.
	ExportPath *string `min:"3" type:"string"`

	// The import path to the Amazon S3 bucket (and optional prefix) that you're
	// using as the data repository for your FSx for Lustre file system, for example
	// s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon
	// S3 bucket name, only object keys with that prefix are loaded into the file
	// system.
	ImportPath *string `min:"3" type:"string"`

	// For files imported from a data repository, this value determines the stripe
	// count and maximum amount of data per file (in MiB) stored on a single physical
	// disk. The maximum number of disks that a single file can be striped across
	// is limited by the total number of disks that make up the file system.
	//
	// The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000
	// MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
	ImportedFileChunkSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration

func (DataRepositoryConfiguration) GoString 

func (s DataRepositoryConfiguration) GoString() string

GoString returns the string representation

func (DataRepositoryConfiguration) String 

func (s DataRepositoryConfiguration) String() string

String returns the string representation

type DeleteBackupInput 

type DeleteBackupInput struct {

	// The ID of the backup you want to delete.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent deletion. This is automatically filled on your behalf when
	// using the AWS CLI or SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

The request object for DeleteBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupRequest

func (DeleteBackupInput) GoString 

func (s DeleteBackupInput) GoString() string

GoString returns the string representation

func (DeleteBackupInput) String 

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate 

func (s *DeleteBackupInput) Validate() error

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

type DeleteBackupOutput 

type DeleteBackupOutput struct {

	// The ID of the backup deleted.
	BackupId *string `min:"12" type:"string"`

	// The lifecycle of the backup. Should be DELETED.
	Lifecycle BackupLifecycle `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The response object for DeleteBackup operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupResponse

func (DeleteBackupOutput) GoString 

func (s DeleteBackupOutput) GoString() string

GoString returns the string representation

func (DeleteBackupOutput) SDKResponseMetadata 

func (s DeleteBackupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteBackupOutput) String 

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteBackupRequest 

type DeleteBackupRequest struct {
	*aws.Request
	Input *DeleteBackupInput
	Copy  func(*DeleteBackupInput) DeleteBackupRequest
}

DeleteBackupRequest is a API request type for the DeleteBackup API operation.

func (DeleteBackupRequest) Send 

func (r DeleteBackupRequest) Send() (*DeleteBackupOutput, error)

Send marshals and sends the DeleteBackup API request.

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent deletion. This is automatically filled on your behalf when
	// using the AWS CLI or SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the file system you want to delete.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The configuration object for the Microsoft Windows file system used in the
	// DeleteFileSystem operation.
	WindowsConfiguration *DeleteFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for DeleteFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemRequest

func (DeleteFileSystemInput) GoString 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation

func (DeleteFileSystemInput) String 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate 

func (s *DeleteFileSystemInput) Validate() error

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

type DeleteFileSystemOutput 

type DeleteFileSystemOutput struct {

	// The ID of the file system being deleted.
	FileSystemId *string `min:"11" type:"string"`

	// The file system lifecycle for the deletion request. Should be DELETING.
	Lifecycle FileSystemLifecycle `type:"string" enum:"true"`

	// The response object for the Microsoft Windows file system used in the DeleteFileSystem
	// operation.
	WindowsResponse *DeleteFileSystemWindowsResponse `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the DeleteFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemResponse

func (DeleteFileSystemOutput) GoString 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation

func (DeleteFileSystemOutput) SDKResponseMetadata 

func (s DeleteFileSystemOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteFileSystemOutput) String 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteFileSystemRequest 

type DeleteFileSystemRequest struct {
	*aws.Request
	Input *DeleteFileSystemInput
	Copy  func(*DeleteFileSystemInput) DeleteFileSystemRequest
}

DeleteFileSystemRequest is a API request type for the DeleteFileSystem API operation.

func (DeleteFileSystemRequest) Send 

func (r DeleteFileSystemRequest) Send() (*DeleteFileSystemOutput, error)

Send marshals and sends the DeleteFileSystem API request.

type DeleteFileSystemWindowsConfiguration 

type DeleteFileSystemWindowsConfiguration struct {

	// A set of tags for your final backup.
	FinalBackupTags []Tag `min:"1" type:"list"`

	// By default, Amazon FSx for Windows takes a final backup on your behalf when
	// the DeleteFileSystem operation is invoked. Doing this helps protect you from
	// data loss, and we highly recommend taking the final backup. If you want to
	// skip this backup, use this flag to do so.
	SkipFinalBackup *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsConfiguration

func (DeleteFileSystemWindowsConfiguration) GoString 

func (s DeleteFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (DeleteFileSystemWindowsConfiguration) String 

func (s DeleteFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*DeleteFileSystemWindowsConfiguration) Validate 

func (s *DeleteFileSystemWindowsConfiguration) Validate() error

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

type DeleteFileSystemWindowsResponse 

type DeleteFileSystemWindowsResponse struct {

	// The ID of the final backup for this file system.
	FinalBackupId *string `min:"12" type:"string"`

	// The set of tags applied to the final backup.
	FinalBackupTags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsResponse

func (DeleteFileSystemWindowsResponse) GoString 

func (s DeleteFileSystemWindowsResponse) GoString() string

GoString returns the string representation

func (DeleteFileSystemWindowsResponse) String 

func (s DeleteFileSystemWindowsResponse) String() string

String returns the string representation

type DescribeBackupsInput 

type DescribeBackupsInput struct {

	// (Optional) IDs of the backups you want to retrieve (String). This overrides
	// any filters. If any IDs are not found, BackupNotFound will be thrown.
	BackupIds []string `type:"list"`

	// (Optional) Filters structure. Supported names are file-system-id and backup-type.
	Filters []Filter `type:"list"`

	// (Optional) Maximum number of backups to return in the response (integer).
	// This parameter value must be greater than 0. The number of items that Amazon
	// FSx returns is the minimum of the MaxResults parameter specified in the request
	// and the service's internal maximum number of items per page.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) Opaque pagination token returned from a previous DescribeBackups
	// operation (String). If a token present, the action continues the list from
	// where the returning call left off.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request object for DescribeBackups operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsRequest

func (DescribeBackupsInput) GoString 

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation

func (DescribeBackupsInput) String 

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate 

func (s *DescribeBackupsInput) Validate() error

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

type DescribeBackupsOutput 

type DescribeBackupsOutput struct {

	// Any array of backups.
	Backups []Backup `type:"list"`

	// This is present if there are more backups than returned in the response (String).
	// You can use the NextToken value in the later request to fetch the backups.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Response object for DescribeBackups operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsResponse

func (DescribeBackupsOutput) GoString 

func (s DescribeBackupsOutput) GoString() string

GoString returns the string representation

func (DescribeBackupsOutput) SDKResponseMetadata 

func (s DescribeBackupsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeBackupsOutput) String 

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeBackupsPager 

type DescribeBackupsPager struct {
	aws.Pager
}

DescribeBackupsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeBackupsPager) CurrentPage 

func (p *DescribeBackupsPager) CurrentPage() *DescribeBackupsOutput

type DescribeBackupsRequest 

type DescribeBackupsRequest struct {
	*aws.Request
	Input *DescribeBackupsInput
	Copy  func(*DescribeBackupsInput) DescribeBackupsRequest
}

DescribeBackupsRequest is a API request type for the DescribeBackups API operation.

func (*DescribeBackupsRequest) Paginate 

func (p *DescribeBackupsRequest) Paginate(opts ...aws.Option) DescribeBackupsPager

Paginate pages iterates over the pages of a DescribeBackupsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeBackups operation.
		req := client.DescribeBackupsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeBackupsRequest) Send 

func (r DescribeBackupsRequest) Send() (*DescribeBackupsOutput, error)

Send marshals and sends the DescribeBackups API request.

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

	// (Optional) IDs of the file systems whose descriptions you want to retrieve
	// (String).
	FileSystemIds []string `type:"list"`

	// (Optional) Maximum number of file systems to return in the response (integer).
	// This parameter value must be greater than 0. The number of items that Amazon
	// FSx returns is the minimum of the MaxResults parameter specified in the request
	// and the service's internal maximum number of items per page.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) Opaque pagination token returned from a previous DescribeFileSystems
	// operation (String). If a token present, the action continues the list from
	// where the returning call left off.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request object for DescribeFileSystems operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsRequest

func (DescribeFileSystemsInput) GoString 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation

func (DescribeFileSystemsInput) String 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate 

func (s *DescribeFileSystemsInput) Validate() error

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

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []FileSystem `type:"list"`

	// Present if there are more file systems than returned in the response (String).
	// You can use the NextToken value in the later request to fetch the descriptions.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response object for DescribeFileSystems operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsResponse

func (DescribeFileSystemsOutput) GoString 

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation

func (DescribeFileSystemsOutput) SDKResponseMetadata 

func (s DescribeFileSystemsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeFileSystemsOutput) String 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeFileSystemsPager 

type DescribeFileSystemsPager struct {
	aws.Pager
}

DescribeFileSystemsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeFileSystemsPager) CurrentPage 

func (p *DescribeFileSystemsPager) CurrentPage() *DescribeFileSystemsOutput

type DescribeFileSystemsRequest 

type DescribeFileSystemsRequest struct {
	*aws.Request
	Input *DescribeFileSystemsInput
	Copy  func(*DescribeFileSystemsInput) DescribeFileSystemsRequest
}

DescribeFileSystemsRequest is a API request type for the DescribeFileSystems API operation.

func (*DescribeFileSystemsRequest) Paginate 

func (p *DescribeFileSystemsRequest) Paginate(opts ...aws.Option) DescribeFileSystemsPager

Paginate pages iterates over the pages of a DescribeFileSystemsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeFileSystems operation.
		req := client.DescribeFileSystemsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeFileSystemsRequest) Send 

func (r DescribeFileSystemsRequest) Send() (*DescribeFileSystemsOutput, error)

Send marshals and sends the DescribeFileSystems API request.

type FSx 

type FSx struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *FSx

New creates a new instance of the FSx client with a config.

Example: 

// Create a FSx client from just a config.
svc := fsx.New(myConfig)

func (*FSx) CreateBackupRequest 

func (c *FSx) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest

CreateBackupRequest returns a request value for making API operation for Amazon FSx.

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information. 

// Example sending a request using the CreateBackupRequest method.
req := client.CreateBackupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackup

Example (Shared00)

To create a new backup

This operation creates a new backup. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateBackupInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyBackup"),
			},
		},
	}

	req := svc.CreateBackupRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeBackupInProgress:
				fmt.Println(fsx.ErrCodeBackupInProgress, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) CreateFileSystemFromBackupRequest 

func (c *FSx) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest

CreateFileSystemFromBackupRequest returns a request value for making API operation for Amazon FSx.

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.

If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. 

// Example sending a request using the CreateFileSystemFromBackupRequest method.
req := client.CreateFileSystemFromBackupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup

Example (Shared00)

To create a new file system from backup

This operation creates a new file system from backup. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateFileSystemFromBackupInput{
		BackupId:           aws.String("backup-03e3c82e0183b7b6b"),
		ClientRequestToken: aws.String("f4c94ed7-238d-4c46-93db-48cd62ec33b7"),
		SecurityGroupIds: []string{
			"sg-edcd9784",
		},
		SubnetIds: []string{
			"subnet-1234abcd",
		},
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
		WindowsConfiguration: &fsx.CreateFileSystemWindowsConfiguration{
			ThroughputCapacity: aws.Int64(8),
		},
	}

	req := svc.CreateFileSystemFromBackupRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeActiveDirectoryError:
				fmt.Println(fsx.ErrCodeActiveDirectoryError, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInvalidNetworkSettings:
				fmt.Println(fsx.ErrCodeInvalidNetworkSettings, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) CreateFileSystemRequest 

func (c *FSx) CreateFileSystemRequest(input *CreateFileSystemInput) CreateFileSystemRequest

CreateFileSystemRequest returns a request value for making API operation for Amazon FSx.

Creates a new, empty Amazon FSx file system.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. 

// Example sending a request using the CreateFileSystemRequest method.
req := client.CreateFileSystemRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystem

Example (Shared00)

To create a new file system

This operation creates a new file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateFileSystemInput{
		ClientRequestToken: aws.String("a8ca07e4-61ec-4399-99f4-19853801bcd5"),
		FileSystemType:     fsx.FileSystemTypeWindows,
		KmsKeyId:           aws.String("arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6"),
		SecurityGroupIds: []string{
			"sg-edcd9784",
		},
		StorageCapacity: aws.Int64(300),
		SubnetIds: []string{
			"subnet-1234abcd",
		},
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
		WindowsConfiguration: &fsx.CreateFileSystemWindowsConfiguration{
			ActiveDirectoryId:             aws.String("d-1234abcd12"),
			AutomaticBackupRetentionDays:  aws.Int64(30),
			DailyAutomaticBackupStartTime: aws.String("05:00"),
			ThroughputCapacity:            aws.Int64(8),
			WeeklyMaintenanceStartTime:    aws.String("1:05:00"),
		},
	}

	req := svc.CreateFileSystemRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeActiveDirectoryError:
				fmt.Println(fsx.ErrCodeActiveDirectoryError, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInvalidImportPath:
				fmt.Println(fsx.ErrCodeInvalidImportPath, aerr.Error())
			case fsx.ErrCodeInvalidNetworkSettings:
				fmt.Println(fsx.ErrCodeInvalidNetworkSettings, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) DeleteBackupRequest 

func (c *FSx) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest

DeleteBackupRequest returns a request value for making API operation for Amazon FSx.

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means. 

// Example sending a request using the DeleteBackupRequest method.
req := client.DeleteBackupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackup

Example (Shared00)

To delete a backup

This operation deletes an Amazon FSx file system backup. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DeleteBackupInput{
		BackupId: aws.String("backup-03e3c82e0183b7b6b"),
	}

	req := svc.DeleteBackupRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeBackupRestoring:
				fmt.Println(fsx.ErrCodeBackupRestoring, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) DeleteFileSystemRequest 

func (c *FSx) DeleteFileSystemRequest(input *DeleteFileSystemInput) DeleteFileSystemRequest

DeleteFileSystemRequest returns a request value for making API operation for Amazon FSx.

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

The data in a deleted file system is also deleted and can't be recovered by any means. 

// Example sending a request using the DeleteFileSystemRequest method.
req := client.DeleteFileSystemRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystem

Example (Shared00)

To delete a file system

This operation deletes an Amazon FSx file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DeleteFileSystemInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
	}

	req := svc.DeleteFileSystemRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) DescribeBackupsRequest 

func (c *FSx) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest

DescribeBackupsRequest returns a request value for making API operation for Amazon FSx.

Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

    // Example sending a request using the DescribeBackupsRequest method. req := client.DescribeBackupsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups

Example (Shared00)

To describe Amazon FSx backups

This operation describes all of the Amazon FSx backups in an account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DescribeBackupsInput{}

	req := svc.DescribeBackupsRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) DescribeFileSystemsRequest 

func (c *FSx) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) DescribeFileSystemsRequest

DescribeFileSystemsRequest returns a request value for making API operation for Amazon FSx.

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

    // Example sending a request using the DescribeFileSystemsRequest method. req := client.DescribeFileSystemsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystems

Example (Shared00)

To describe an Amazon FSx file system

This operation describes all of the Amazon FSx file systems in an account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DescribeFileSystemsInput{}

	req := svc.DescribeFileSystemsRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) ListTagsForResourceRequest 

func (c *FSx) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon FSx.

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

    // Example sending a request using the ListTagsForResourceRequest method. req := client.ListTagsForResourceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResource

Example (Shared00)

To list tags for a resource

This operation lists tags for an Amazon FSx resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.ListTagsForResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
	}

	req := svc.ListTagsForResourceRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) TagResourceRequest 

func (c *FSx) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon FSx.

Tags an Amazon FSx resource. 

// Example sending a request using the TagResourceRequest method.
req := client.TagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResource

Example (Shared00)

To tag a resource

This operation tags an Amazon FSx resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.TagResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	req := svc.TagResourceRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) UntagResourceRequest 

func (c *FSx) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon FSx.

This action removes a tag from an Amazon FSx resource. 

// Example sending a request using the UntagResourceRequest method.
req := client.UntagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResource

Example (Shared00)

To untag a resource

This operation untags an Amazon FSx resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.UntagResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
		TagKeys: []string{
			"Name",
		},
	}

	req := svc.UntagResourceRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) UpdateFileSystemRequest 

func (c *FSx) UpdateFileSystemRequest(input *UpdateFileSystemInput) UpdateFileSystemRequest

UpdateFileSystemRequest returns a request value for making API operation for Amazon FSx.

Updates a file system configuration. 

// Example sending a request using the UpdateFileSystemRequest method.
req := client.UpdateFileSystemRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystem

Example (Shared00)

To update an existing file system

This operation updates an existing file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.UpdateFileSystemInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
		WindowsConfiguration: &fsx.UpdateFileSystemWindowsConfiguration{
			AutomaticBackupRetentionDays:  aws.Int64(10),
			DailyAutomaticBackupStartTime: aws.String("06:00"),
			WeeklyMaintenanceStartTime:    aws.String("3:06:00"),
		},
	}

	req := svc.UpdateFileSystemRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

type FileSystem 

type FileSystem struct {

	// The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z),
	// also known as Unix time.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The DNS name for the file system.
	DNSName *string `min:"16" type:"string"`

	// Structure providing details of any failures that occur when creating the
	// file system has failed.
	FailureDetails *FileSystemFailureDetails `type:"structure"`

	// The eight-digit ID of the file system that was automatically assigned by
	// Amazon FSx.
	FileSystemId *string `min:"11" type:"string"`

	// Type of file system. Currently the only supported type is WINDOWS.
	FileSystemType FileSystemType `type:"string" enum:"true"`

	// The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the
	// file system's data for an Amazon FSx for Windows File Server file system.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle status of the file system.
	Lifecycle FileSystemLifecycle `type:"string" enum:"true"`

	// The configuration for the Amazon FSx for Lustre file system.
	LustreConfiguration *LustreFileSystemConfiguration `type:"structure"`

	// The IDs of the elastic network interface from which a specific file system
	// is accessible. The elastic network interface is automatically created in
	// the same VPC that the Amazon FSx file system was created in. For more information,
	// see Elastic Network Interfaces (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html)
	// in the Amazon EC2 User Guide.
	//
	// For an Amazon FSx for Windows File Server file system, you can have one network
	// interface Id. For an Amazon FSx for Lustre file system, you can have more
	// than one.
	NetworkInterfaceIds []string `type:"list"`

	// The AWS account that created the file system. If the file system was created
	// by an IAM user, the AWS account to which the IAM user belongs is the owner.
	OwnerId *string `min:"12" type:"string"`

	// The resource ARN of the file system.
	ResourceARN *string `min:"8" type:"string"`

	// The storage capacity of the file system in gigabytes.
	StorageCapacity *int64 `min:"300" type:"integer"`

	// The IDs of the subnets to contain the endpoint for the file system. One and
	// only one is supported. The file system is launched in the Availability Zone
	// associated with this subnet.
	SubnetIds []string `type:"list"`

	// The tags to associate with the file system. For more information, see Tagging
	// Your Amazon EC2 Resources (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html)
	// in the Amazon EC2 User Guide.
	Tags []Tag `min:"1" type:"list"`

	// The ID of the primary VPC for the file system.
	VpcId *string `min:"12" type:"string"`

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *WindowsFileSystemConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

A description of a specific Amazon FSx file system. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystem

func (FileSystem) GoString 

func (s FileSystem) GoString() string

GoString returns the string representation

func (FileSystem) String 

func (s FileSystem) String() string

String returns the string representation

type FileSystemFailureDetails 

type FileSystemFailureDetails struct {

	// Message describing the failures that occurred during file system creation.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Structure providing details of any failures that occur when creating the file system has failed. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails

func (FileSystemFailureDetails) GoString 

func (s FileSystemFailureDetails) GoString() string

GoString returns the string representation

func (FileSystemFailureDetails) String 

func (s FileSystemFailureDetails) String() string

String returns the string representation

type FileSystemLifecycle 

type FileSystemLifecycle string

The lifecycle status of the file system. 

const (
	FileSystemLifecycleAvailable FileSystemLifecycle = "AVAILABLE"
	FileSystemLifecycleCreating  FileSystemLifecycle = "CREATING"
	FileSystemLifecycleFailed    FileSystemLifecycle = "FAILED"
	FileSystemLifecycleDeleting  FileSystemLifecycle = "DELETING"
)

Enum values for FileSystemLifecycle

func (FileSystemLifecycle) MarshalValue 

func (enum FileSystemLifecycle) MarshalValue() (string, error)

func (FileSystemLifecycle) MarshalValueBuf 

func (enum FileSystemLifecycle) MarshalValueBuf(b []byte) ([]byte, error)

type FileSystemMaintenanceOperation 

type FileSystemMaintenanceOperation string

An enumeration specifying the currently ongoing maintenance operation. 

const (
	FileSystemMaintenanceOperationPatching  FileSystemMaintenanceOperation = "PATCHING"
	FileSystemMaintenanceOperationBackingUp FileSystemMaintenanceOperation = "BACKING_UP"
)

Enum values for FileSystemMaintenanceOperation

func (FileSystemMaintenanceOperation) MarshalValue 

func (enum FileSystemMaintenanceOperation) MarshalValue() (string, error)

func (FileSystemMaintenanceOperation) MarshalValueBuf 

func (enum FileSystemMaintenanceOperation) MarshalValueBuf(b []byte) ([]byte, error)

type FileSystemType 

type FileSystemType string

The type of file system. 

const (
	FileSystemTypeWindows FileSystemType = "WINDOWS"
	FileSystemTypeLustre  FileSystemType = "LUSTRE"
)

Enum values for FileSystemType

func (FileSystemType) MarshalValue 

func (enum FileSystemType) MarshalValue() (string, error)

func (FileSystemType) MarshalValueBuf 

func (enum FileSystemType) MarshalValueBuf(b []byte) ([]byte, error)

type Filter 

type Filter struct {

	// The name for this filter.
	Name FilterName `type:"string" enum:"true"`

	// The values of the filter. These are all the values for any of the applied
	// filters.
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Filter

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation

func (Filter) String 

func (s Filter) String() string

String returns the string representation

type FilterName 

type FilterName string

The name for a filter. 

const (
	FilterNameFileSystemId FilterName = "file-system-id"
	FilterNameBackupType   FilterName = "backup-type"
)

Enum values for FilterName

func (FilterName) MarshalValue 

func (enum FilterName) MarshalValue() (string, error)

func (FilterName) MarshalValueBuf 

func (enum FilterName) MarshalValueBuf(b []byte) ([]byte, error)

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// (Optional) Maximum number of tags to return in the response (integer). This
	// parameter value must be greater than 0. The number of items that Amazon FSx
	// returns is the minimum of the MaxResults parameter specified in the request
	// and the service's internal maximum number of items per page.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) Opaque pagination token returned from a previous ListTagsForResource
	// operation (String). If a token present, the action continues the list from
	// where the returning call left off.
	NextToken *string `min:"1" type:"string"`

	// The ARN of the Amazon FSx resource that will have its tags listed.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request object for ListTagsForResource operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceRequest

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

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 {

	// This is present if there are more tags than returned in the response (String).
	// You can use the NextToken value in the later request to fetch the tags.
	NextToken *string `min:"1" type:"string"`

	// A list of tags on the resource.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for ListTagsForResource operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceResponse

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (ListTagsForResourceOutput) SDKResponseMetadata 

func (s ListTagsForResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is a API request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send() (*ListTagsForResourceOutput, error)

Send marshals and sends the ListTagsForResource API request.

type LustreFileSystemConfiguration 

type LustreFileSystemConfiguration struct {

	// The data repository configuration object for Lustre file systems returned
	// in the response of the CreateFileSystem operation.
	DataRepositoryConfiguration *DataRepositoryConfiguration `type:"structure"`

	// The UTC time that you want to begin your weekly maintenance window.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration for the Amazon FSx for Lustre file system. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreFileSystemConfiguration

func (LustreFileSystemConfiguration) GoString 

func (s LustreFileSystemConfiguration) GoString() string

GoString returns the string representation

func (LustreFileSystemConfiguration) String 

func (s LustreFileSystemConfiguration) String() string

String returns the string representation

type ServiceLimit 

type ServiceLimit string

The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific AWS Region. You can increase some of them by contacting AWS Support. 

const (
	ServiceLimitFileSystemCount           ServiceLimit = "FILE_SYSTEM_COUNT"
	ServiceLimitTotalThroughputCapacity   ServiceLimit = "TOTAL_THROUGHPUT_CAPACITY"
	ServiceLimitTotalStorage              ServiceLimit = "TOTAL_STORAGE"
	ServiceLimitTotalUserInitiatedBackups ServiceLimit = "TOTAL_USER_INITIATED_BACKUPS"
)

Enum values for ServiceLimit

func (ServiceLimit) MarshalValue 

func (enum ServiceLimit) MarshalValue() (string, error)

func (ServiceLimit) MarshalValueBuf 

func (enum ServiceLimit) MarshalValueBuf(b []byte) ([]byte, error)

type Tag 

type Tag struct {

	// A value that specifies the TagKey, the name of the tag. Tag keys must be
	// unique for the resource to which they are attached.
	Key *string `min:"1" type:"string"`

	// A value that specifies the TagValue, the value assigned to the corresponding
	// tag key. Tag values can be null and don't have to be unique in a tag set.
	// For example, you can have a key-value pair in a tag set of finances : April
	// and also of payroll : April.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a key-value pair for a resource tag. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to
	// tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`

	// A list of tags for the resource. If a tag with a given key already exists,
	// the value is replaced by the one specified in this parameter.
	//
	// Tags is a required field
	Tags []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request object for the TagResource operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

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
}

The response object for the TagResource operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) SDKResponseMetadata 

func (s TagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is a API request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send() (*TagResourceOutput, error)

Send marshals and sends the TagResource API request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the Amazon FSx resource to untag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`

	// A list of keys of tags on the resource to untag. In case the tag key doesn't
	// exist, the call will still succeed to be idempotent.
	//
	// TagKeys is a required field
	TagKeys []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request object for UntagResource action. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceRequest

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

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
}

The response object for UntagResource action. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceResponse

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) SDKResponseMetadata 

func (s UntagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is a API request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send() (*UntagResourceOutput, error)

Send marshals and sends the UntagResource API request.

type UpdateFileSystemInput 

type UpdateFileSystemInput struct {

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
	// ensure idempotent updates. This string is automatically filled on your behalf
	// when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The globally unique ID of the file system, assigned by Amazon FSx.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The configuration object for Amazon FSx for Lustre file systems used in the
	// UpdateFileSystem operation.
	LustreConfiguration *UpdateFileSystemLustreConfiguration `type:"structure"`

	// The configuration for this Microsoft Windows file system. The only supported
	// options are for backup and maintenance.
	WindowsConfiguration *UpdateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for the UpdateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest

func (UpdateFileSystemInput) GoString 

func (s UpdateFileSystemInput) GoString() string

GoString returns the string representation

func (UpdateFileSystemInput) String 

func (s UpdateFileSystemInput) String() string

String returns the string representation

func (*UpdateFileSystemInput) Validate 

func (s *UpdateFileSystemInput) Validate() error

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

type UpdateFileSystemLustreConfiguration 

type UpdateFileSystemLustreConfiguration struct {

	// The preferred time to perform weekly maintenance, in the UTC time zone.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemLustreConfiguration

func (UpdateFileSystemLustreConfiguration) GoString 

func (s UpdateFileSystemLustreConfiguration) GoString() string

GoString returns the string representation

func (UpdateFileSystemLustreConfiguration) String 

func (s UpdateFileSystemLustreConfiguration) String() string

String returns the string representation

func (*UpdateFileSystemLustreConfiguration) Validate 

func (s *UpdateFileSystemLustreConfiguration) Validate() error

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

type UpdateFileSystemOutput 

type UpdateFileSystemOutput struct {

	// A description of the file system.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the UpdateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemResponse

func (UpdateFileSystemOutput) GoString 

func (s UpdateFileSystemOutput) GoString() string

GoString returns the string representation

func (UpdateFileSystemOutput) SDKResponseMetadata 

func (s UpdateFileSystemOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateFileSystemOutput) String 

func (s UpdateFileSystemOutput) String() string

String returns the string representation

type UpdateFileSystemRequest 

type UpdateFileSystemRequest struct {
	*aws.Request
	Input *UpdateFileSystemInput
	Copy  func(*UpdateFileSystemInput) UpdateFileSystemRequest
}

UpdateFileSystemRequest is a API request type for the UpdateFileSystem API operation.

func (UpdateFileSystemRequest) Send 

func (r UpdateFileSystemRequest) Send() (*UpdateFileSystemOutput, error)

Send marshals and sends the UpdateFileSystem API request.

type UpdateFileSystemWindowsConfiguration 

type UpdateFileSystemWindowsConfiguration struct {

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

	// The preferred time to take daily automatic backups, in the UTC time zone.
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// The preferred time to perform weekly maintenance, in the UTC time zone.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for the Microsoft Windows file system used in the UpdateFileSystem operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemWindowsConfiguration

func (UpdateFileSystemWindowsConfiguration) GoString 

func (s UpdateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (UpdateFileSystemWindowsConfiguration) String 

func (s UpdateFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*UpdateFileSystemWindowsConfiguration) Validate 

func (s *UpdateFileSystemWindowsConfiguration) Validate() error

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

type WindowsFileSystemConfiguration 

type WindowsFileSystemConfiguration struct {

	// The ID for an existing Microsoft Active Directory instance that the file
	// system should join when it's created.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

	// A boolean flag indicating whether tags on the file system should be copied
	// to backups. This value defaults to false. If it's set to true, all tags on
	// the file system are copied to all automatic backups and any user-initiated
	// backups where the user doesn't specify any tags. If this value is true, and
	// you specify one or more tags, only the specified tags are copied to backups.
	CopyTagsToBackups *bool `type:"boolean"`

	// The preferred time to take daily automatic backups, in the UTC time zone.
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// The list of maintenance operations in progress for this file system.
	MaintenanceOperationsInProgress []FileSystemMaintenanceOperation `type:"list"`

	// The throughput of an Amazon FSx file system, measured in megabytes per second.
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// The preferred time to perform weekly maintenance, in the UTC time zone.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration for this Microsoft Windows file system. Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration

func (WindowsFileSystemConfiguration) GoString 

func (s WindowsFileSystemConfiguration) GoString() string

GoString returns the string representation

func (WindowsFileSystemConfiguration) String 

func (s WindowsFileSystemConfiguration) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package fsxiface provides an interface to enable mocking the Amazon FSx service client for testing your code.
 Package fsxiface provides an interface to enable mocking the Amazon FSx 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.