package storagegateway
import "github.com/aws/aws-sdk-go-v2/service/storagegateway"
Package storagegateway provides the API client, operations, and parameter types for AWS Storage Gateway.
AWS Storage Gateway Service AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery. Use the following links to get started using the AWS Storage Gateway Service API Reference:
* AWS Storage Gateway required request headers (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders): Describes the required headers that you must send with every POST request to AWS Storage Gateway.
* Signing requests (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests): AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
* Error responses (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses): Provides reference information about AWS Storage Gateway errors.
* Operations in AWS Storage Gateway (https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html): Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
* AWS Storage Gateway endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html): Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.
AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected. IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs (http://aws.amazon.com/ec2/faqs/#longer-ids). For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016 (http://forums.aws.amazon.com/ann.jspa?annID=3557).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- type ActivateGatewayInput
- type ActivateGatewayOutput
- type AddCacheInput
- type AddCacheOutput
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type AddUploadBufferInput
- type AddUploadBufferOutput
- type AddWorkingStorageInput
- type AddWorkingStorageOutput
- type AssignTapePoolInput
- type AssignTapePoolOutput
- type AttachVolumeInput
- type AttachVolumeOutput
- type CancelArchivalInput
- type CancelArchivalOutput
- type CancelRetrievalInput
- type CancelRetrievalOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInput, optFns ...func(*Options)) (*ActivateGatewayOutput, error)
- func (c *Client) AddCache(ctx context.Context, params *AddCacheInput, optFns ...func(*Options)) (*AddCacheOutput, error)
- func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)
- func (c *Client) AddUploadBuffer(ctx context.Context, params *AddUploadBufferInput, optFns ...func(*Options)) (*AddUploadBufferOutput, error)
- func (c *Client) AddWorkingStorage(ctx context.Context, params *AddWorkingStorageInput, optFns ...func(*Options)) (*AddWorkingStorageOutput, error)
- func (c *Client) AssignTapePool(ctx context.Context, params *AssignTapePoolInput, optFns ...func(*Options)) (*AssignTapePoolOutput, error)
- func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, optFns ...func(*Options)) (*AttachVolumeOutput, error)
- func (c *Client) CancelArchival(ctx context.Context, params *CancelArchivalInput, optFns ...func(*Options)) (*CancelArchivalOutput, error)
- func (c *Client) CancelRetrieval(ctx context.Context, params *CancelRetrievalInput, optFns ...func(*Options)) (*CancelRetrievalOutput, error)
- func (c *Client) CreateCachediSCSIVolume(ctx context.Context, params *CreateCachediSCSIVolumeInput, optFns ...func(*Options)) (*CreateCachediSCSIVolumeOutput, error)
- func (c *Client) CreateNFSFileShare(ctx context.Context, params *CreateNFSFileShareInput, optFns ...func(*Options)) (*CreateNFSFileShareOutput, error)
- func (c *Client) CreateSMBFileShare(ctx context.Context, params *CreateSMBFileShareInput, optFns ...func(*Options)) (*CreateSMBFileShareOutput, error)
- func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)
- func (c *Client) CreateSnapshotFromVolumeRecoveryPoint(ctx context.Context, params *CreateSnapshotFromVolumeRecoveryPointInput, optFns ...func(*Options)) (*CreateSnapshotFromVolumeRecoveryPointOutput, error)
- func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStorediSCSIVolumeInput, optFns ...func(*Options)) (*CreateStorediSCSIVolumeOutput, error)
- func (c *Client) CreateTapePool(ctx context.Context, params *CreateTapePoolInput, optFns ...func(*Options)) (*CreateTapePoolOutput, error)
- func (c *Client) CreateTapeWithBarcode(ctx context.Context, params *CreateTapeWithBarcodeInput, optFns ...func(*Options)) (*CreateTapeWithBarcodeOutput, error)
- func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optFns ...func(*Options)) (*CreateTapesOutput, error)
- func (c *Client) DeleteAutomaticTapeCreationPolicy(ctx context.Context, params *DeleteAutomaticTapeCreationPolicyInput, optFns ...func(*Options)) (*DeleteAutomaticTapeCreationPolicyOutput, error)
- func (c *Client) DeleteBandwidthRateLimit(ctx context.Context, params *DeleteBandwidthRateLimitInput, optFns ...func(*Options)) (*DeleteBandwidthRateLimitOutput, error)
- func (c *Client) DeleteChapCredentials(ctx context.Context, params *DeleteChapCredentialsInput, optFns ...func(*Options)) (*DeleteChapCredentialsOutput, error)
- func (c *Client) DeleteFileShare(ctx context.Context, params *DeleteFileShareInput, optFns ...func(*Options)) (*DeleteFileShareOutput, error)
- func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)
- func (c *Client) DeleteSnapshotSchedule(ctx context.Context, params *DeleteSnapshotScheduleInput, optFns ...func(*Options)) (*DeleteSnapshotScheduleOutput, error)
- func (c *Client) DeleteTape(ctx context.Context, params *DeleteTapeInput, optFns ...func(*Options)) (*DeleteTapeOutput, error)
- func (c *Client) DeleteTapeArchive(ctx context.Context, params *DeleteTapeArchiveInput, optFns ...func(*Options)) (*DeleteTapeArchiveOutput, error)
- func (c *Client) DeleteTapePool(ctx context.Context, params *DeleteTapePoolInput, optFns ...func(*Options)) (*DeleteTapePoolOutput, error)
- func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error)
- func (c *Client) DescribeAvailabilityMonitorTest(ctx context.Context, params *DescribeAvailabilityMonitorTestInput, optFns ...func(*Options)) (*DescribeAvailabilityMonitorTestOutput, error)
- func (c *Client) DescribeBandwidthRateLimit(ctx context.Context, params *DescribeBandwidthRateLimitInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitOutput, error)
- func (c *Client) DescribeBandwidthRateLimitSchedule(ctx context.Context, params *DescribeBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitScheduleOutput, error)
- func (c *Client) DescribeCache(ctx context.Context, params *DescribeCacheInput, optFns ...func(*Options)) (*DescribeCacheOutput, error)
- func (c *Client) DescribeCachediSCSIVolumes(ctx context.Context, params *DescribeCachediSCSIVolumesInput, optFns ...func(*Options)) (*DescribeCachediSCSIVolumesOutput, error)
- func (c *Client) DescribeChapCredentials(ctx context.Context, params *DescribeChapCredentialsInput, optFns ...func(*Options)) (*DescribeChapCredentialsOutput, error)
- func (c *Client) DescribeGatewayInformation(ctx context.Context, params *DescribeGatewayInformationInput, optFns ...func(*Options)) (*DescribeGatewayInformationOutput, error)
- func (c *Client) DescribeMaintenanceStartTime(ctx context.Context, params *DescribeMaintenanceStartTimeInput, optFns ...func(*Options)) (*DescribeMaintenanceStartTimeOutput, error)
- func (c *Client) DescribeNFSFileShares(ctx context.Context, params *DescribeNFSFileSharesInput, optFns ...func(*Options)) (*DescribeNFSFileSharesOutput, error)
- func (c *Client) DescribeSMBFileShares(ctx context.Context, params *DescribeSMBFileSharesInput, optFns ...func(*Options)) (*DescribeSMBFileSharesOutput, error)
- func (c *Client) DescribeSMBSettings(ctx context.Context, params *DescribeSMBSettingsInput, optFns ...func(*Options)) (*DescribeSMBSettingsOutput, error)
- func (c *Client) DescribeSnapshotSchedule(ctx context.Context, params *DescribeSnapshotScheduleInput, optFns ...func(*Options)) (*DescribeSnapshotScheduleOutput, error)
- func (c *Client) DescribeStorediSCSIVolumes(ctx context.Context, params *DescribeStorediSCSIVolumesInput, optFns ...func(*Options)) (*DescribeStorediSCSIVolumesOutput, error)
- func (c *Client) DescribeTapeArchives(ctx context.Context, params *DescribeTapeArchivesInput, optFns ...func(*Options)) (*DescribeTapeArchivesOutput, error)
- func (c *Client) DescribeTapeRecoveryPoints(ctx context.Context, params *DescribeTapeRecoveryPointsInput, optFns ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error)
- func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, optFns ...func(*Options)) (*DescribeTapesOutput, error)
- func (c *Client) DescribeUploadBuffer(ctx context.Context, params *DescribeUploadBufferInput, optFns ...func(*Options)) (*DescribeUploadBufferOutput, error)
- func (c *Client) DescribeVTLDevices(ctx context.Context, params *DescribeVTLDevicesInput, optFns ...func(*Options)) (*DescribeVTLDevicesOutput, error)
- func (c *Client) DescribeWorkingStorage(ctx context.Context, params *DescribeWorkingStorageInput, optFns ...func(*Options)) (*DescribeWorkingStorageOutput, error)
- func (c *Client) DetachVolume(ctx context.Context, params *DetachVolumeInput, optFns ...func(*Options)) (*DetachVolumeOutput, error)
- func (c *Client) DisableGateway(ctx context.Context, params *DisableGatewayInput, optFns ...func(*Options)) (*DisableGatewayOutput, error)
- func (c *Client) JoinDomain(ctx context.Context, params *JoinDomainInput, optFns ...func(*Options)) (*JoinDomainOutput, error)
- func (c *Client) ListAutomaticTapeCreationPolicies(ctx context.Context, params *ListAutomaticTapeCreationPoliciesInput, optFns ...func(*Options)) (*ListAutomaticTapeCreationPoliciesOutput, error)
- func (c *Client) ListFileShares(ctx context.Context, params *ListFileSharesInput, optFns ...func(*Options)) (*ListFileSharesOutput, error)
- func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)
- func (c *Client) ListLocalDisks(ctx context.Context, params *ListLocalDisksInput, optFns ...func(*Options)) (*ListLocalDisksOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTapePools(ctx context.Context, params *ListTapePoolsInput, optFns ...func(*Options)) (*ListTapePoolsOutput, error)
- func (c *Client) ListTapes(ctx context.Context, params *ListTapesInput, optFns ...func(*Options)) (*ListTapesOutput, error)
- func (c *Client) ListVolumeInitiators(ctx context.Context, params *ListVolumeInitiatorsInput, optFns ...func(*Options)) (*ListVolumeInitiatorsOutput, error)
- func (c *Client) ListVolumeRecoveryPoints(ctx context.Context, params *ListVolumeRecoveryPointsInput, optFns ...func(*Options)) (*ListVolumeRecoveryPointsOutput, error)
- func (c *Client) ListVolumes(ctx context.Context, params *ListVolumesInput, optFns ...func(*Options)) (*ListVolumesOutput, error)
- func (c *Client) NotifyWhenUploaded(ctx context.Context, params *NotifyWhenUploadedInput, optFns ...func(*Options)) (*NotifyWhenUploadedOutput, error)
- func (c *Client) RefreshCache(ctx context.Context, params *RefreshCacheInput, optFns ...func(*Options)) (*RefreshCacheOutput, error)
- func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)
- func (c *Client) ResetCache(ctx context.Context, params *ResetCacheInput, optFns ...func(*Options)) (*ResetCacheOutput, error)
- func (c *Client) RetrieveTapeArchive(ctx context.Context, params *RetrieveTapeArchiveInput, optFns ...func(*Options)) (*RetrieveTapeArchiveOutput, error)
- func (c *Client) RetrieveTapeRecoveryPoint(ctx context.Context, params *RetrieveTapeRecoveryPointInput, optFns ...func(*Options)) (*RetrieveTapeRecoveryPointOutput, error)
- func (c *Client) SetLocalConsolePassword(ctx context.Context, params *SetLocalConsolePasswordInput, optFns ...func(*Options)) (*SetLocalConsolePasswordOutput, error)
- func (c *Client) SetSMBGuestPassword(ctx context.Context, params *SetSMBGuestPasswordInput, optFns ...func(*Options)) (*SetSMBGuestPasswordOutput, error)
- func (c *Client) ShutdownGateway(ctx context.Context, params *ShutdownGatewayInput, optFns ...func(*Options)) (*ShutdownGatewayOutput, error)
- func (c *Client) StartAvailabilityMonitorTest(ctx context.Context, params *StartAvailabilityMonitorTestInput, optFns ...func(*Options)) (*StartAvailabilityMonitorTestOutput, error)
- func (c *Client) StartGateway(ctx context.Context, params *StartGatewayInput, optFns ...func(*Options)) (*StartGatewayOutput, error)
- func (c *Client) UpdateAutomaticTapeCreationPolicy(ctx context.Context, params *UpdateAutomaticTapeCreationPolicyInput, optFns ...func(*Options)) (*UpdateAutomaticTapeCreationPolicyOutput, error)
- func (c *Client) UpdateBandwidthRateLimit(ctx context.Context, params *UpdateBandwidthRateLimitInput, optFns ...func(*Options)) (*UpdateBandwidthRateLimitOutput, error)
- func (c *Client) UpdateBandwidthRateLimitSchedule(ctx context.Context, params *UpdateBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*UpdateBandwidthRateLimitScheduleOutput, error)
- func (c *Client) UpdateChapCredentials(ctx context.Context, params *UpdateChapCredentialsInput, optFns ...func(*Options)) (*UpdateChapCredentialsOutput, error)
- func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGatewayInformationInput, optFns ...func(*Options)) (*UpdateGatewayInformationOutput, error)
- func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error)
- func (c *Client) UpdateMaintenanceStartTime(ctx context.Context, params *UpdateMaintenanceStartTimeInput, optFns ...func(*Options)) (*UpdateMaintenanceStartTimeOutput, error)
- func (c *Client) UpdateNFSFileShare(ctx context.Context, params *UpdateNFSFileShareInput, optFns ...func(*Options)) (*UpdateNFSFileShareOutput, error)
- func (c *Client) UpdateSMBFileShare(ctx context.Context, params *UpdateSMBFileShareInput, optFns ...func(*Options)) (*UpdateSMBFileShareOutput, error)
- func (c *Client) UpdateSMBFileShareVisibility(ctx context.Context, params *UpdateSMBFileShareVisibilityInput, optFns ...func(*Options)) (*UpdateSMBFileShareVisibilityOutput, error)
- func (c *Client) UpdateSMBSecurityStrategy(ctx context.Context, params *UpdateSMBSecurityStrategyInput, optFns ...func(*Options)) (*UpdateSMBSecurityStrategyOutput, error)
- func (c *Client) UpdateSnapshotSchedule(ctx context.Context, params *UpdateSnapshotScheduleInput, optFns ...func(*Options)) (*UpdateSnapshotScheduleOutput, error)
- func (c *Client) UpdateVTLDeviceType(ctx context.Context, params *UpdateVTLDeviceTypeInput, optFns ...func(*Options)) (*UpdateVTLDeviceTypeOutput, error)
- type CreateCachediSCSIVolumeInput
- type CreateCachediSCSIVolumeOutput
- type CreateNFSFileShareInput
- type CreateNFSFileShareOutput
- type CreateSMBFileShareInput
- type CreateSMBFileShareOutput
- type CreateSnapshotFromVolumeRecoveryPointInput
- type CreateSnapshotFromVolumeRecoveryPointOutput
- type CreateSnapshotInput
- type CreateSnapshotOutput
- type CreateStorediSCSIVolumeInput
- type CreateStorediSCSIVolumeOutput
- type CreateTapePoolInput
- type CreateTapePoolOutput
- type CreateTapeWithBarcodeInput
- type CreateTapeWithBarcodeOutput
- type CreateTapesInput
- type CreateTapesOutput
- type DeleteAutomaticTapeCreationPolicyInput
- type DeleteAutomaticTapeCreationPolicyOutput
- type DeleteBandwidthRateLimitInput
- type DeleteBandwidthRateLimitOutput
- type DeleteChapCredentialsInput
- type DeleteChapCredentialsOutput
- type DeleteFileShareInput
- type DeleteFileShareOutput
- type DeleteGatewayInput
- type DeleteGatewayOutput
- type DeleteSnapshotScheduleInput
- type DeleteSnapshotScheduleOutput
- type DeleteTapeArchiveInput
- type DeleteTapeArchiveOutput
- type DeleteTapeInput
- type DeleteTapeOutput
- type DeleteTapePoolInput
- type DeleteTapePoolOutput
- type DeleteVolumeInput
- type DeleteVolumeOutput
- type DescribeAvailabilityMonitorTestInput
- type DescribeAvailabilityMonitorTestOutput
- type DescribeBandwidthRateLimitInput
- type DescribeBandwidthRateLimitOutput
- type DescribeBandwidthRateLimitScheduleInput
- type DescribeBandwidthRateLimitScheduleOutput
- type DescribeCacheInput
- type DescribeCacheOutput
- type DescribeCachediSCSIVolumesInput
- type DescribeCachediSCSIVolumesOutput
- type DescribeChapCredentialsInput
- type DescribeChapCredentialsOutput
- type DescribeGatewayInformationInput
- type DescribeGatewayInformationOutput
- type DescribeMaintenanceStartTimeInput
- type DescribeMaintenanceStartTimeOutput
- type DescribeNFSFileSharesInput
- type DescribeNFSFileSharesOutput
- type DescribeSMBFileSharesInput
- type DescribeSMBFileSharesOutput
- type DescribeSMBSettingsInput
- type DescribeSMBSettingsOutput
- type DescribeSnapshotScheduleInput
- type DescribeSnapshotScheduleOutput
- type DescribeStorediSCSIVolumesInput
- type DescribeStorediSCSIVolumesOutput
- type DescribeTapeArchivesAPIClient
- type DescribeTapeArchivesInput
- type DescribeTapeArchivesOutput
- type DescribeTapeArchivesPaginator
- func NewDescribeTapeArchivesPaginator(client DescribeTapeArchivesAPIClient, params *DescribeTapeArchivesInput, optFns ...func(*DescribeTapeArchivesPaginatorOptions)) *DescribeTapeArchivesPaginator
- func (p *DescribeTapeArchivesPaginator) HasMorePages() bool
- func (p *DescribeTapeArchivesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapeArchivesOutput, error)
- type DescribeTapeArchivesPaginatorOptions
- type DescribeTapeRecoveryPointsAPIClient
- type DescribeTapeRecoveryPointsInput
- type DescribeTapeRecoveryPointsOutput
- type DescribeTapeRecoveryPointsPaginator
- func NewDescribeTapeRecoveryPointsPaginator(client DescribeTapeRecoveryPointsAPIClient, params *DescribeTapeRecoveryPointsInput, optFns ...func(*DescribeTapeRecoveryPointsPaginatorOptions)) *DescribeTapeRecoveryPointsPaginator
- func (p *DescribeTapeRecoveryPointsPaginator) HasMorePages() bool
- func (p *DescribeTapeRecoveryPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error)
- type DescribeTapeRecoveryPointsPaginatorOptions
- type DescribeTapesAPIClient
- type DescribeTapesInput
- type DescribeTapesOutput
- type DescribeTapesPaginator
- func NewDescribeTapesPaginator(client DescribeTapesAPIClient, params *DescribeTapesInput, optFns ...func(*DescribeTapesPaginatorOptions)) *DescribeTapesPaginator
- func (p *DescribeTapesPaginator) HasMorePages() bool
- func (p *DescribeTapesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapesOutput, error)
- type DescribeTapesPaginatorOptions
- type DescribeUploadBufferInput
- type DescribeUploadBufferOutput
- type DescribeVTLDevicesAPIClient
- type DescribeVTLDevicesInput
- type DescribeVTLDevicesOutput
- type DescribeVTLDevicesPaginator
- func NewDescribeVTLDevicesPaginator(client DescribeVTLDevicesAPIClient, params *DescribeVTLDevicesInput, optFns ...func(*DescribeVTLDevicesPaginatorOptions)) *DescribeVTLDevicesPaginator
- func (p *DescribeVTLDevicesPaginator) HasMorePages() bool
- func (p *DescribeVTLDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeVTLDevicesOutput, error)
- type DescribeVTLDevicesPaginatorOptions
- type DescribeWorkingStorageInput
- type DescribeWorkingStorageOutput
- type DetachVolumeInput
- type DetachVolumeOutput
- type DisableGatewayInput
- type DisableGatewayOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type JoinDomainInput
- type JoinDomainOutput
- type ListAutomaticTapeCreationPoliciesInput
- type ListAutomaticTapeCreationPoliciesOutput
- type ListFileSharesAPIClient
- type ListFileSharesInput
- type ListFileSharesOutput
- type ListFileSharesPaginator
- func NewListFileSharesPaginator(client ListFileSharesAPIClient, params *ListFileSharesInput, optFns ...func(*ListFileSharesPaginatorOptions)) *ListFileSharesPaginator
- func (p *ListFileSharesPaginator) HasMorePages() bool
- func (p *ListFileSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFileSharesOutput, error)
- type ListFileSharesPaginatorOptions
- type ListGatewaysAPIClient
- type ListGatewaysInput
- type ListGatewaysOutput
- type ListGatewaysPaginator
- func NewListGatewaysPaginator(client ListGatewaysAPIClient, params *ListGatewaysInput, optFns ...func(*ListGatewaysPaginatorOptions)) *ListGatewaysPaginator
- func (p *ListGatewaysPaginator) HasMorePages() bool
- func (p *ListGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewaysOutput, error)
- type ListGatewaysPaginatorOptions
- type ListLocalDisksInput
- type ListLocalDisksOutput
- type ListTagsForResourceAPIClient
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourcePaginator
- func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator
- func (p *ListTagsForResourcePaginator) HasMorePages() bool
- func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- type ListTagsForResourcePaginatorOptions
- type ListTapePoolsAPIClient
- type ListTapePoolsInput
- type ListTapePoolsOutput
- type ListTapePoolsPaginator
- func NewListTapePoolsPaginator(client ListTapePoolsAPIClient, params *ListTapePoolsInput, optFns ...func(*ListTapePoolsPaginatorOptions)) *ListTapePoolsPaginator
- func (p *ListTapePoolsPaginator) HasMorePages() bool
- func (p *ListTapePoolsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTapePoolsOutput, error)
- type ListTapePoolsPaginatorOptions
- type ListTapesAPIClient
- type ListTapesInput
- type ListTapesOutput
- type ListTapesPaginator
- func NewListTapesPaginator(client ListTapesAPIClient, params *ListTapesInput, optFns ...func(*ListTapesPaginatorOptions)) *ListTapesPaginator
- func (p *ListTapesPaginator) HasMorePages() bool
- func (p *ListTapesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTapesOutput, error)
- type ListTapesPaginatorOptions
- type ListVolumeInitiatorsInput
- type ListVolumeInitiatorsOutput
- type ListVolumeRecoveryPointsInput
- type ListVolumeRecoveryPointsOutput
- type ListVolumesAPIClient
- type ListVolumesInput
- type ListVolumesOutput
- type ListVolumesPaginator
- func NewListVolumesPaginator(client ListVolumesAPIClient, params *ListVolumesInput, optFns ...func(*ListVolumesPaginatorOptions)) *ListVolumesPaginator
- func (p *ListVolumesPaginator) HasMorePages() bool
- func (p *ListVolumesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVolumesOutput, error)
- type ListVolumesPaginatorOptions
- type NotifyWhenUploadedInput
- type NotifyWhenUploadedOutput
- type Options
- type RefreshCacheInput
- type RefreshCacheOutput
- type RemoveTagsFromResourceInput
- type RemoveTagsFromResourceOutput
- type ResetCacheInput
- type ResetCacheOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type RetrieveTapeArchiveInput
- type RetrieveTapeArchiveOutput
- type RetrieveTapeRecoveryPointInput
- type RetrieveTapeRecoveryPointOutput
- type SetLocalConsolePasswordInput
- type SetLocalConsolePasswordOutput
- type SetSMBGuestPasswordInput
- type SetSMBGuestPasswordOutput
- type ShutdownGatewayInput
- type ShutdownGatewayOutput
- type StartAvailabilityMonitorTestInput
- type StartAvailabilityMonitorTestOutput
- type StartGatewayInput
- type StartGatewayOutput
- type UpdateAutomaticTapeCreationPolicyInput
- type UpdateAutomaticTapeCreationPolicyOutput
- type UpdateBandwidthRateLimitInput
- type UpdateBandwidthRateLimitOutput
- type UpdateBandwidthRateLimitScheduleInput
- type UpdateBandwidthRateLimitScheduleOutput
- type UpdateChapCredentialsInput
- type UpdateChapCredentialsOutput
- type UpdateGatewayInformationInput
- type UpdateGatewayInformationOutput
- type UpdateGatewaySoftwareNowInput
- type UpdateGatewaySoftwareNowOutput
- type UpdateMaintenanceStartTimeInput
- type UpdateMaintenanceStartTimeOutput
- type UpdateNFSFileShareInput
- type UpdateNFSFileShareOutput
- type UpdateSMBFileShareInput
- type UpdateSMBFileShareOutput
- type UpdateSMBFileShareVisibilityInput
- type UpdateSMBFileShareVisibilityOutput
- type UpdateSMBSecurityStrategyInput
- type UpdateSMBSecurityStrategyOutput
- type UpdateSnapshotScheduleInput
- type UpdateSnapshotScheduleOutput
- type UpdateVTLDeviceTypeInput
- type UpdateVTLDeviceTypeOutput
Constants ¶
const ServiceAPIVersion = "2013-06-30"
const ServiceID = "Storage Gateway"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
Types ¶
type ActivateGatewayInput ¶
type ActivateGatewayInput struct { // Your gateway activation key. You can obtain the activation key by sending an // HTTP GET request with redirects enabled to the gateway IP address (port 80). The // redirect URL returned in the response provides you the activation key for your // gateway in the query string parameter activationKey. It may also include other // activation-related parameters, however, these are merely defaults -- the // arguments you pass to the ActivateGateway API call determine the actual // configuration of your gateway. For more information, see Getting activation key // (https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html) // in the AWS Storage Gateway User Guide. // // This member is required. ActivationKey *string // The name you configured for your gateway. // // This member is required. GatewayName *string // A value that indicates the AWS Region where you want to store your data. The // gateway AWS Region specified must be the same AWS Region as the AWS Region in // your Host header in the request. For more information about available AWS // Regions and endpoints for AWS Storage Gateway, see AWS Storage Gateway endpoints // and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the AWS // General Reference. Valid Values: See AWS Storage Gateway endpoints and quotas // (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the AWS General // Reference. // // This member is required. GatewayRegion *string // A value that indicates the time zone you want to set for the gateway. The time // zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 // indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours // ahead of GMT. The time zone is used, for example, for scheduling snapshots and // your gateway's maintenance schedule. // // This member is required. GatewayTimezone *string // A value that defines the type of gateway to activate. The type specified is // critical to all later functions of the gateway and cannot be changed after // activation. The default value is CACHED. Valid Values: STORED | CACHED | VTL | // FILE_S3 GatewayType *string // The value that indicates the type of medium changer to use for tape gateway. // This field is optional. Valid Values: STK-L700 | AWS-Gateway-VTL | // IBM-03584L32-0402 MediumChangerType *string // A list of up to 50 tags that you can assign to the gateway. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers that can be represented in UTF-8 format, and the following special // characters: + - = . _ : / @. The maximum length of a tag's key is 128 // characters, and the maximum length for a tag's value is 256 characters. Tags []types.Tag // The value that indicates the type of tape drive to use for tape gateway. This // field is optional. Valid Values: IBM-ULT3580-TD5 TapeDriveType *string }
A JSON object containing one or more of the following fields:
* ActivateGatewayInput$ActivationKey
* ActivateGatewayInput$GatewayName
* ActivateGatewayInput$GatewayRegion
* ActivateGatewayInput$GatewayTimezone
* ActivateGatewayInput$GatewayType
* ActivateGatewayInput$MediumChangerType
* ActivateGatewayInput$TapeDriveType
type ActivateGatewayOutput ¶
type ActivateGatewayOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and AWS Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization. For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.
type AddCacheInput ¶
type AddCacheInput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks API. // // This member is required. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type AddCacheOutput ¶
type AddCacheOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddTagsToResourceInput ¶
type AddTagsToResourceInput struct { // The Amazon Resource Name (ARN) of the resource you want to add tags to. // // This member is required. ResourceARN *string // The key-value pair that represents the tag you want to add to the resource. The // value can be an empty string. Valid characters for key and value are letters, // spaces, and numbers representable in UTF-8 format, and the following special // characters: + - = . _ : / @. The maximum length of a tag's key is 128 // characters, and the maximum length for a tag's value is 256. // // This member is required. Tags []types.Tag }
AddTagsToResourceInput
type AddTagsToResourceOutput ¶
type AddTagsToResourceOutput struct { // The Amazon Resource Name (ARN) of the resource you want to add tags to. ResourceARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
AddTagsToResourceOutput
type AddUploadBufferInput ¶
type AddUploadBufferInput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks API. // // This member is required. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type AddUploadBufferOutput ¶
type AddUploadBufferOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddWorkingStorageInput ¶
type AddWorkingStorageInput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks API. // // This member is required. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing one or more of the following fields:
* AddWorkingStorageInput$DiskIds
type AddWorkingStorageOutput ¶
type AddWorkingStorageOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
type AssignTapePoolInput ¶
type AssignTapePoolInput struct { // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the S3 storage class that is associated with the pool. // When you use your backup application to eject the tape, the tape is archived // directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that // corresponds to the pool. Valid Values: GLACIER | DEEP_ARCHIVE // // This member is required. PoolId *string // The unique Amazon Resource Name (ARN) of the virtual tape that you want to add // to the tape pool. // // This member is required. TapeARN *string // Set permissions to bypass governance retention. If the lock type of the archived // tape is Governance, the tape's archived age is not older than // RetentionLockInDays, and the user does not already have // BypassGovernanceRetention, setting this to TRUE enables the user to bypass the // retention lock. This parameter is set to true by default for calls from the // console. Valid values: TRUE | FALSE BypassGovernanceRetention bool }
type AssignTapePoolOutput ¶
type AssignTapePoolOutput struct { // The unique Amazon Resource Names (ARN) of the virtual tape that was added to the // tape pool. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AttachVolumeInput ¶
type AttachVolumeInput struct { // The Amazon Resource Name (ARN) of the gateway that you want to attach the volume // to. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the // network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string // The Amazon Resource Name (ARN) of the volume to attach to the specified gateway. // // This member is required. VolumeARN *string // The unique device ID or other distinguishing data that identifies the local disk // used to create the volume. This value is only required when you are attaching a // stored volume. DiskId *string // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. // The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. TargetName *string }
AttachVolumeInput
type AttachVolumeOutput ¶
type AttachVolumeOutput struct { // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name for the initiator that was used to connect to the target. TargetARN *string // The Amazon Resource Name (ARN) of the volume that was attached to the gateway. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
AttachVolumeOutput
type CancelArchivalInput ¶
type CancelArchivalInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving // for. // // This member is required. TapeARN *string }
CancelArchivalInput
type CancelArchivalOutput ¶
type CancelArchivalOutput struct { // The Amazon Resource Name (ARN) of the virtual tape for which archiving was // canceled. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CancelArchivalOutput
type CancelRetrievalInput ¶
type CancelRetrievalInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval // for. // // This member is required. TapeARN *string }
CancelRetrievalInput
type CancelRetrievalOutput ¶
type CancelRetrievalOutput struct { // The Amazon Resource Name (ARN) of the virtual tape for which retrieval was // canceled. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CancelRetrievalOutput
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Storage Gateway.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) ActivateGateway ¶
func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInput, optFns ...func(*Options)) (*ActivateGatewayOutput, error)
Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway.
func (*Client) AddCache ¶
func (c *Client) AddCache(ctx context.Context, params *AddCacheInput, optFns ...func(*Options)) (*AddCacheOutput, error)
Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How AWS Storage Gateway works (architecture) (https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
func (*Client) AddTagsToResource ¶
func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)
Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:
* Storage gateways of all types
* Storage volumes
* Virtual tapes
* NFS and SMB file shares
You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
func (*Client) AddUploadBuffer ¶
func (c *Client) AddUploadBuffer(ctx context.Context, params *AddUploadBufferInput, optFns ...func(*Options)) (*AddUploadBufferOutput, error)
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
func (*Client) AddWorkingStorage ¶
func (c *Client) AddWorkingStorage(ctx context.Context, params *AddWorkingStorageInput, optFns ...func(*Options)) (*AddWorkingStorageOutput, error)
Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
func (*Client) AssignTapePool ¶
func (c *Client) AssignTapePool(ctx context.Context, params *AssignTapePoolInput, optFns ...func(*Options)) (*AssignTapePoolOutput, error)
Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. Valid Values: GLACIER | DEEP_ARCHIVE
func (*Client) AttachVolume ¶
func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, optFns ...func(*Options)) (*AttachVolumeOutput, error)
Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
func (*Client) CancelArchival ¶
func (c *Client) CancelArchival(ctx context.Context, params *CancelArchivalInput, optFns ...func(*Options)) (*CancelArchivalOutput, error)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.
func (*Client) CancelRetrieval ¶
func (c *Client) CancelRetrieval(ctx context.Context, params *CancelRetrievalInput, optFns ...func(*Options)) (*CancelRetrievalOutput, error)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
func (*Client) CreateCachediSCSIVolume ¶
func (c *Client) CreateCachediSCSIVolume(ctx context.Context, params *CreateCachediSCSIVolumeInput, optFns ...func(*Options)) (*CreateCachediSCSIVolumeOutput, error)
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
func (*Client) CreateNFSFileShare ¶
func (c *Client) CreateNFSFileShare(ctx context.Context, params *CreateNFSFileShareInput, optFns ...func(*Options)) (*CreateNFSFileShareOutput, error)
Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways. File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the AWS Identity and Access Management User Guide. File gateway does not support creating hard or symbolic links on a file share.
func (*Client) CreateSMBFileShare ¶
func (c *Client) CreateSMBFileShare(ctx context.Context, params *CreateSMBFileShareInput, optFns ...func(*Options)) (*CreateSMBFileShareOutput, error)
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
func (*Client) CreateSnapshot ¶
func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)
Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot). In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the Amazon Elastic Compute Cloud API Reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome (https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) page.
func (*Client) CreateSnapshotFromVolumeRecoveryPoint ¶
func (c *Client) CreateSnapshotFromVolumeRecoveryPoint(ctx context.Context, params *CreateSnapshotFromVolumeRecoveryPointInput, optFns ...func(*Options)) (*CreateSnapshotFromVolumeRecoveryPointOutput, error)
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the Amazon Elastic Compute Cloud API Reference.
func (*Client) CreateStorediSCSIVolume ¶
func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStorediSCSIVolumeInput, optFns ...func(*Options)) (*CreateStorediSCSIVolumeOutput, error)
Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
func (*Client) CreateTapePool ¶
func (c *Client) CreateTapePool(ctx context.Context, params *CreateTapePoolInput, optFns ...func(*Options)) (*CreateTapePoolOutput, error)
Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
func (*Client) CreateTapeWithBarcode ¶
func (c *Client) CreateTapeWithBarcode(ctx context.Context, params *CreateTapeWithBarcodeInput, optFns ...func(*Options)) (*CreateTapeWithBarcodeOutput, error)
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
func (*Client) CreateTapes ¶
func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optFns ...func(*Options)) (*CreateTapesOutput, error)
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
func (*Client) DeleteAutomaticTapeCreationPolicy ¶
func (c *Client) DeleteAutomaticTapeCreationPolicy(ctx context.Context, params *DeleteAutomaticTapeCreationPolicyInput, optFns ...func(*Options)) (*DeleteAutomaticTapeCreationPolicyOutput, error)
Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
func (*Client) DeleteBandwidthRateLimit ¶
func (c *Client) DeleteBandwidthRateLimit(ctx context.Context, params *DeleteBandwidthRateLimitInput, optFns ...func(*Options)) (*DeleteBandwidthRateLimitOutput, error)
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for the stored volume, cached volume and tape gateway types.
func (*Client) DeleteChapCredentials ¶
func (c *Client) DeleteChapCredentials(ctx context.Context, params *DeleteChapCredentialsInput, optFns ...func(*Options)) (*DeleteChapCredentialsOutput, error)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
func (*Client) DeleteFileShare ¶
func (c *Client) DeleteFileShare(ctx context.Context, params *DeleteFileShareInput, optFns ...func(*Options)) (*DeleteFileShareOutput, error)
Deletes a file share from a file gateway. This operation is only supported for file gateways.
func (*Client) DeleteGateway ¶
func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)
Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway detail page (http://aws.amazon.com/storagegateway).
func (*Client) DeleteSnapshotSchedule ¶
func (c *Client) DeleteSnapshotSchedule(ctx context.Context, params *DeleteSnapshotScheduleInput, optFns ...func(*Options)) (*DeleteSnapshotScheduleOutput, error)
Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes (https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html). In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) in the Amazon Elastic Compute Cloud API Reference.
func (*Client) DeleteTape ¶
func (c *Client) DeleteTape(ctx context.Context, params *DeleteTapeInput, optFns ...func(*Options)) (*DeleteTapeOutput, error)
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
func (*Client) DeleteTapeArchive ¶
func (c *Client) DeleteTapeArchive(ctx context.Context, params *DeleteTapeArchiveInput, optFns ...func(*Options)) (*DeleteTapeArchiveOutput, error)
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
func (*Client) DeleteTapePool ¶
func (c *Client) DeleteTapePool(ctx context.Context, params *DeleteTapePoolInput, optFns ...func(*Options)) (*DeleteTapePoolOutput, error)
Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
func (*Client) DeleteVolume ¶
func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
func (*Client) DescribeAvailabilityMonitorTest ¶
func (c *Client) DescribeAvailabilityMonitorTest(ctx context.Context, params *DescribeAvailabilityMonitorTestInput, optFns ...func(*Options)) (*DescribeAvailabilityMonitorTestOutput, error)
Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
func (*Client) DescribeBandwidthRateLimit ¶
func (c *Client) DescribeBandwidthRateLimit(ctx context.Context, params *DescribeBandwidthRateLimitInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitOutput, error)
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume, and tape gateway types. This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
func (*Client) DescribeBandwidthRateLimitSchedule ¶
func (c *Client) DescribeBandwidthRateLimitSchedule(ctx context.Context, params *DescribeBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitScheduleOutput, error)
Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only in the volume and tape gateway types. This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both. A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
func (*Client) DescribeCache ¶
func (c *Client) DescribeCache(ctx context.Context, params *DescribeCacheInput, optFns ...func(*Options)) (*DescribeCacheOutput, error)
Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
func (*Client) DescribeCachediSCSIVolumes ¶
func (c *Client) DescribeCachediSCSIVolumes(ctx context.Context, params *DescribeCachediSCSIVolumesInput, optFns ...func(*Options)) (*DescribeCachediSCSIVolumesOutput, error)
Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
func (*Client) DescribeChapCredentials ¶
func (c *Client) DescribeChapCredentials(ctx context.Context, params *DescribeChapCredentialsInput, optFns ...func(*Options)) (*DescribeChapCredentialsOutput, error)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
func (*Client) DescribeGatewayInformation ¶
func (c *Client) DescribeGatewayInformation(ctx context.Context, params *DescribeGatewayInformationInput, optFns ...func(*Options)) (*DescribeGatewayInformationOutput, error)
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
func (*Client) DescribeMaintenanceStartTime ¶
func (c *Client) DescribeMaintenanceStartTime(ctx context.Context, params *DescribeMaintenanceStartTimeInput, optFns ...func(*Options)) (*DescribeMaintenanceStartTimeOutput, error)
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
func (*Client) DescribeNFSFileShares ¶
func (c *Client) DescribeNFSFileShares(ctx context.Context, params *DescribeNFSFileSharesInput, optFns ...func(*Options)) (*DescribeNFSFileSharesOutput, error)
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
func (*Client) DescribeSMBFileShares ¶
func (c *Client) DescribeSMBFileShares(ctx context.Context, params *DescribeSMBFileSharesInput, optFns ...func(*Options)) (*DescribeSMBFileSharesOutput, error)
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
func (*Client) DescribeSMBSettings ¶
func (c *Client) DescribeSMBSettings(ctx context.Context, params *DescribeSMBSettingsInput, optFns ...func(*Options)) (*DescribeSMBSettingsOutput, error)
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
func (*Client) DescribeSnapshotSchedule ¶
func (c *Client) DescribeSnapshotSchedule(ctx context.Context, params *DescribeSnapshotScheduleInput, optFns ...func(*Options)) (*DescribeSnapshotScheduleOutput, error)
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
func (*Client) DescribeStorediSCSIVolumes ¶
func (c *Client) DescribeStorediSCSIVolumes(ctx context.Context, params *DescribeStorediSCSIVolumesInput, optFns ...func(*Options)) (*DescribeStorediSCSIVolumesOutput, error)
Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
func (*Client) DescribeTapeArchives ¶
func (c *Client) DescribeTapeArchives(ctx context.Context, params *DescribeTapeArchivesInput, optFns ...func(*Options)) (*DescribeTapeArchivesOutput, error)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
func (*Client) DescribeTapeRecoveryPoints ¶
func (c *Client) DescribeTapeRecoveryPoints(ctx context.Context, params *DescribeTapeRecoveryPointsInput, optFns ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error)
Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.
func (*Client) DescribeTapes ¶
func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, optFns ...func(*Options)) (*DescribeTapesOutput, error)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
func (*Client) DescribeUploadBuffer ¶
func (c *Client) DescribeUploadBuffer(ctx context.Context, params *DescribeUploadBufferInput, optFns ...func(*Options)) (*DescribeUploadBufferOutput, error)
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
func (*Client) DescribeVTLDevices ¶
func (c *Client) DescribeVTLDevices(ctx context.Context, params *DescribeVTLDevicesInput, optFns ...func(*Options)) (*DescribeVTLDevicesOutput, error)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type.
func (*Client) DescribeWorkingStorage ¶
func (c *Client) DescribeWorkingStorage(ctx context.Context, params *DescribeWorkingStorageInput, optFns ...func(*Options)) (*DescribeWorkingStorageOutput, error)
Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
func (*Client) DetachVolume ¶
func (c *Client) DetachVolume(ctx context.Context, params *DetachVolumeInput, optFns ...func(*Options)) (*DetachVolumeOutput, error)
Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
func (*Client) DisableGateway ¶
func (c *Client) DisableGateway(ctx context.Context, params *DisableGatewayInput, optFns ...func(*Options)) (*DisableGatewayOutput, error)
Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. After a gateway is disabled, it cannot be enabled.
func (*Client) JoinDomain ¶
func (c *Client) JoinDomain(ctx context.Context, params *JoinDomainInput, optFns ...func(*Options)) (*JoinDomainOutput, error)
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
func (*Client) ListAutomaticTapeCreationPolicies ¶
func (c *Client) ListAutomaticTapeCreationPolicies(ctx context.Context, params *ListAutomaticTapeCreationPoliciesInput, optFns ...func(*Options)) (*ListAutomaticTapeCreationPoliciesOutput, error)
Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list. This operation is only supported for tape gateways.
func (*Client) ListFileShares ¶
func (c *Client) ListFileShares(ctx context.Context, params *ListFileSharesInput, optFns ...func(*Options)) (*ListFileSharesOutput, error)
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.
func (*Client) ListGateways ¶
func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)
Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
func (*Client) ListLocalDisks ¶
func (c *Client) ListLocalDisks(ctx context.Context, params *ListLocalDisksInput, optFns ...func(*Options)) (*ListLocalDisksOutput, error)
Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
func (*Client) ListTapePools ¶
func (c *Client) ListTapePools(ctx context.Context, params *ListTapePoolsInput, optFns ...func(*Options)) (*ListTapePoolsOutput, error)
Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.
func (*Client) ListTapes ¶
func (c *Client) ListTapes(ctx context.Context, params *ListTapesInput, optFns ...func(*Options)) (*ListTapesOutput, error)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.
func (*Client) ListVolumeInitiators ¶
func (c *Client) ListVolumeInitiators(ctx context.Context, params *ListVolumeInitiatorsInput, optFns ...func(*Options)) (*ListVolumeInitiatorsOutput, error)
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
func (*Client) ListVolumeRecoveryPoints ¶
func (c *Client) ListVolumeRecoveryPoints(ctx context.Context, params *ListVolumeRecoveryPointsInput, optFns ...func(*Options)) (*ListVolumeRecoveryPointsOutput, error)
Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
func (*Client) ListVolumes ¶
func (c *Client) ListVolumes(ctx context.Context, params *ListVolumesInput, optFns ...func(*Options)) (*ListVolumesOutput, error)
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
func (*Client) NotifyWhenUploaded ¶
func (c *Client) NotifyWhenUploaded(ctx context.Context, params *NotifyWhenUploadedInput, optFns ...func(*Options)) (*NotifyWhenUploadedOutput, error)
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3. AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. For more information, see Getting file upload notification (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification) in the AWS Storage Gateway User Guide.
func (*Client) RefreshCache ¶
func (c *Client) RefreshCache(ctx context.Context, params *RefreshCacheInput, optFns ...func(*Options)) (*RefreshCacheOutput, error)
Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) in the AWS Storage Gateway User Guide. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) in the AWS Storage Gateway User Guide. If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server. For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) in the AWS Storage Gateway User Guide.
func (*Client) RemoveTagsFromResource ¶
func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)
Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
func (*Client) ResetCache ¶
func (c *Client) ResetCache(ctx context.Context, params *ResetCacheInput, optFns ...func(*Options)) (*ResetCacheOutput, error)
Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
func (*Client) RetrieveTapeArchive ¶
func (c *Client) RetrieveTapeArchive(ctx context.Context, params *RetrieveTapeArchiveInput, optFns ...func(*Options)) (*RetrieveTapeArchiveOutput, error)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
func (*Client) RetrieveTapeRecoveryPoint ¶
func (c *Client) RetrieveTapeRecoveryPoint(ctx context.Context, params *RetrieveTapeRecoveryPointInput, optFns ...func(*Options)) (*RetrieveTapeRecoveryPointOutput, error)
Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.
func (*Client) SetLocalConsolePassword ¶
func (c *Client) SetLocalConsolePassword(ctx context.Context, params *SetLocalConsolePasswordInput, optFns ...func(*Options)) (*SetLocalConsolePasswordOutput, error)
Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
func (*Client) SetSMBGuestPassword ¶
func (c *Client) SetSMBGuestPassword(ctx context.Context, params *SetSMBGuestPasswordInput, optFns ...func(*Options)) (*SetSMBGuestPasswordOutput, error)
Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.
func (*Client) ShutdownGateway ¶
func (c *Client) ShutdownGateway(ctx context.Context, params *ShutdownGatewayInput, optFns ...func(*Options)) (*ShutdownGatewayOutput, error)
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
func (*Client) StartAvailabilityMonitorTest ¶
func (c *Client) StartAvailabilityMonitorTest(ctx context.Context, params *StartAvailabilityMonitorTestInput, optFns ...func(*Options)) (*StartAvailabilityMonitorTestOutput, error)
Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period.
func (*Client) StartGateway ¶
func (c *Client) StartGateway(ctx context.Context, params *StartGatewayInput, optFns ...func(*Options)) (*StartGatewayOutput, error)
Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
func (*Client) UpdateAutomaticTapeCreationPolicy ¶
func (c *Client) UpdateAutomaticTapeCreationPolicy(ctx context.Context, params *UpdateAutomaticTapeCreationPolicyInput, optFns ...func(*Options)) (*UpdateAutomaticTapeCreationPolicyOutput, error)
Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic tape creation policy. A gateway can have only one automatic tape creation policy.
func (*Client) UpdateBandwidthRateLimit ¶
func (c *Client) UpdateBandwidthRateLimit(ctx context.Context, params *UpdateBandwidthRateLimitInput, optFns ...func(*Options)) (*UpdateBandwidthRateLimitOutput, error)
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume, and tape gateway types. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
func (*Client) UpdateBandwidthRateLimitSchedule ¶
func (c *Client) UpdateBandwidthRateLimitSchedule(ctx context.Context, params *UpdateBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*UpdateBandwidthRateLimitScheduleOutput, error)
Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported in the volume and tape gateway types.
func (*Client) UpdateChapCredentials ¶
func (c *Client) UpdateChapCredentials(ctx context.Context, params *UpdateChapCredentialsInput, optFns ...func(*Options)) (*UpdateChapCredentialsOutput, error)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
func (*Client) UpdateGatewayInformation ¶
func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGatewayInformationInput, optFns ...func(*Options)) (*UpdateGatewayInformationOutput, error)
Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
func (*Client) UpdateGatewaySoftwareNow ¶
func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) and Customizing your Linux iSCSI settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), respectively.
func (*Client) UpdateMaintenanceStartTime ¶
func (c *Client) UpdateMaintenanceStartTime(ctx context.Context, params *UpdateMaintenanceStartTimeInput, optFns ...func(*Options)) (*UpdateMaintenanceStartTimeOutput, error)
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
func (*Client) UpdateNFSFileShare ¶
func (c *Client) UpdateNFSFileShare(ctx context.Context, params *UpdateNFSFileShareInput, optFns ...func(*Options)) (*UpdateNFSFileShareOutput, error)
Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share settings:
* Default storage class for your S3 bucket
* Metadata defaults for your S3 bucket
* Allowed NFS clients for your file share
* Squash settings
* Write status of your file share
func (*Client) UpdateSMBFileShare ¶
func (c *Client) UpdateSMBFileShare(ctx context.Context, params *UpdateSMBFileShareInput, optFns ...func(*Options)) (*UpdateSMBFileShareOutput, error)
Updates a Server Message Block (SMB) file share. This operation is only supported for file gateways. To leave a file share field unchanged, set the corresponding input field to null. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
func (*Client) UpdateSMBFileShareVisibility ¶
func (c *Client) UpdateSMBFileShareVisibility(ctx context.Context, params *UpdateSMBFileShareVisibilityInput, optFns ...func(*Options)) (*UpdateSMBFileShareVisibilityOutput, error)
Controls whether the shares on a gateway are visible in a net view or browse list.
func (*Client) UpdateSMBSecurityStrategy ¶
func (c *Client) UpdateSMBSecurityStrategy(ctx context.Context, params *UpdateSMBSecurityStrategyInput, optFns ...func(*Options)) (*UpdateSMBSecurityStrategyOutput, error)
Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance of the gateway.
func (*Client) UpdateSnapshotSchedule ¶
func (c *Client) UpdateSnapshotSchedule(ctx context.Context, params *UpdateSnapshotScheduleInput, optFns ...func(*Options)) (*UpdateSnapshotScheduleOutput, error)
Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
func (*Client) UpdateVTLDeviceType ¶
func (c *Client) UpdateVTLDeviceType(ctx context.Context, params *UpdateVTLDeviceTypeInput, optFns ...func(*Options)) (*UpdateVTLDeviceTypeOutput, error)
Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
type CreateCachediSCSIVolumeInput ¶
type CreateCachediSCSIVolumeInput struct { // A unique identifier that you use to retry a request. If you retry a request, use // the same ClientToken you specified in the initial request. // // This member is required. ClientToken *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the // network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. // The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. // // This member is required. TargetName *string // The size of the volume in bytes. // // This member is required. VolumeSizeInBytes int64 // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new // cached volume. Specify this field if you want to create the iSCSI storage volume // from a snapshot; otherwise, do not include this field. To list snapshots for // your account use DescribeSnapshots // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string // The ARN for an existing volume. Specifying this ARN makes the new volume into an // exact copy of the specified existing volume's latest recovery point. The // VolumeSizeInBytes value for this new volume must be equal to or larger than the // size of the existing volume, in bytes. SourceVolumeARN *string // A list of up to 50 tags that you can assign to a cached volume. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers that you can represent in UTF-8 format, and the following special // characters: + - = . _ : / @. The maximum length of a tag's key is 128 // characters, and the maximum length for a tag's value is 256 characters. Tags []types.Tag }
type CreateCachediSCSIVolumeOutput ¶
type CreateCachediSCSIVolumeOutput struct { // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name that initiators can use to connect to the target. TargetARN *string // The Amazon Resource Name (ARN) of the configured volume. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateNFSFileShareInput ¶
type CreateNFSFileShareInput struct { // A unique string value that you supply that is used by file gateway to ensure // idempotent file share creation. // // This member is required. *string // The Amazon Resource Name (ARN) of the file gateway on which you want to create a // file share. // // This member is required. *string // The ARN of the backend storage used for storing file data. A prefix name can be // added to the S3 bucket name. It must end with a "/". // // This member is required. *string // The ARN of the AWS Identity and Access Management (IAM) role that a file gateway // assumes when it accesses the underlying storage. // // This member is required. *string // Refresh cache information. *types.CacheAttributes // The list of clients that are allowed to access the file gateway. The list must // contain either valid IP addresses or valid CIDR blocks. []string // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix // name is set in LocationARN. *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise // set to false. The default value is true. Valid Values: true | false *bool // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. *string // File share default values. Optional. *types.NFSFileShareDefaults // The notification policy of the file share. *string // A value that sets the access control list (ACL) permission for objects in the S3 // bucket that a file gateway puts objects into. The default value is private. types.ObjectACL // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false. Valid Values: true | // false *bool // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket // owner always pays the cost of storing data. RequesterPays is a configuration for // the S3 bucket that backs the file share, so make sure that the configuration on // the file share is the same as the S3 bucket configuration. Valid Values: true | // false *bool // A value that maps a user to anonymous user. Valid values are the following: // // * // RootSquash: Only root is mapped to anonymous user. // // * NoSquash: No one is mapped // to anonymous user. // // * AllSquash: Everyone is mapped to anonymous user. *string // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is // a key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. []types.Tag }
CreateNFSFileShareInput
type CreateNFSFileShareOutput ¶
type CreateNFSFileShareOutput struct { // The Amazon Resource Name (ARN) of the newly created file share. *string // Metadata pertaining to the operation's result. middleware.Metadata }
CreateNFSFileShareOutput
type CreateSMBFileShareInput ¶
type CreateSMBFileShareInput struct { // A unique string value that you supply that is used by file gateway to ensure // idempotent file share creation. // // This member is required. *string // The ARN of the file gateway on which you want to create a file share. // // This member is required. *string // The ARN of the backend storage used for storing file data. A prefix name can be // added to the S3 bucket name. It must end with a "/". // // This member is required. *string // The ARN of the AWS Identity and Access Management (IAM) role that a file gateway // assumes when it accesses the underlying storage. // // This member is required. *string // The files and folders on this share will only be visible to users with read // access. *bool // A list of users or groups in the Active Directory that will be granted // administrator privileges on the file share. These users can do all file // operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, // @group1, and @DOMAIN\group1. Use this option very carefully, because any user in // this list can do anything they like on the file share, regardless of file // permissions. []string // The Amazon Resource Name (ARN) of the storage used for the audit logs. *string // The authentication method that users use to access the file share. The default // is ActiveDirectory. Valid Values: ActiveDirectory | GuestAccess *string // Refresh cache information. *types.CacheAttributes // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the // client determines the case sensitivity. For CaseSensitive, the gateway // determines the case sensitivity. The default value is ClientSpecified. types.CaseSensitivity // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix // name is set in LocationARN. *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise // set to false. The default value is true. Valid Values: true | false *bool // A list of users or groups in the Active Directory that are not allowed to access // the file share. A group must be prefixed with the @ character. Acceptable // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be // set if Authentication is set to ActiveDirectory. []string // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. *string // The notification policy of the file share. *string // A value that sets the access control list (ACL) permission for objects in the S3 // bucket that a file gateway puts objects into. The default value is private. types.ObjectACL // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false. Valid Values: true | // false *bool // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket // owner always pays the cost of storing data. RequesterPays is a configuration for // the S3 bucket that backs the file share, so make sure that the configuration on // the file share is the same as the S3 bucket configuration. Valid Values: true | // false *bool // Set this value to true to enable access control list (ACL) on the SMB file // share. Set it to false to map file and directory permissions to the POSIX // permissions. For more information, see Using Microsoft Windows ACLs to control // access to an SMB file share // (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in // the AWS Storage Gateway User Guide. Valid Values: true | false *bool // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is // a key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. []types.Tag // A list of users or groups in the Active Directory that are allowed to access the // file share. A group must be prefixed with the @ character. Acceptable formats // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if // Authentication is set to ActiveDirectory. []string }
CreateSMBFileShareInput
type CreateSMBFileShareOutput ¶
type CreateSMBFileShareOutput struct { // The Amazon Resource Name (ARN) of the newly created file share. *string // Metadata pertaining to the operation's result. middleware.Metadata }
CreateSMBFileShareOutput
type CreateSnapshotFromVolumeRecoveryPointInput ¶
type CreateSnapshotFromVolumeRecoveryPointInput struct { // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the AWS // Storage Gateway snapshot Details pane, Description field. // // This member is required. SnapshotDescription *string // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for // specified VolumeARN. // // This member is required. VolumeARN *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag }
type CreateSnapshotFromVolumeRecoveryPointOutput ¶
type CreateSnapshotFromVolumeRecoveryPointOutput struct { // The ID of the snapshot. SnapshotId *string // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for // specified VolumeARN. VolumeARN *string // The time the volume was created from the recovery point. VolumeRecoveryPointTime *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateSnapshotInput ¶
type CreateSnapshotInput struct { // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the AWS // Storage Gateway snapshot Details pane, Description field. // // This member is required. SnapshotDescription *string // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes. // // This member is required. VolumeARN *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag }
A JSON object containing one or more of the following fields:
* CreateSnapshotInput$SnapshotDescription
* CreateSnapshotInput$VolumeARN
type CreateSnapshotOutput ¶
type CreateSnapshotOutput struct { // The snapshot ID that is used to refer to the snapshot in future operations such // as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or // creating a volume from a snapshot (CreateStorediSCSIVolume). SnapshotId *string // The Amazon Resource Name (ARN) of the volume of which the snapshot was taken. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type CreateStorediSCSIVolumeInput ¶
type CreateStorediSCSIVolumeInput struct { // The unique identifier for the gateway local disk that is configured as a stored // volume. Use ListLocalDisks // (https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html) // to list disk IDs for a gateway. // // This member is required. DiskId *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the // network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string // Set to true true if you want to preserve the data on the local disk. Otherwise, // set to false to create an empty volume. Valid Values: true | false // // This member is required. PreserveExistingData bool // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. // The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. // // This member is required. TargetName *string // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new // stored volume. Specify this field if you want to create the iSCSI storage volume // from a snapshot; otherwise, do not include this field. To list snapshots for // your account use DescribeSnapshots // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string // A list of up to 50 tags that can be assigned to a stored volume. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag }
A JSON object containing one or more of the following fields:
* CreateStorediSCSIVolumeInput$DiskId
* CreateStorediSCSIVolumeInput$NetworkInterfaceId
* CreateStorediSCSIVolumeInput$PreserveExistingData
* CreateStorediSCSIVolumeInput$SnapshotId
* CreateStorediSCSIVolumeInput$TargetName
type CreateStorediSCSIVolumeOutput ¶
type CreateStorediSCSIVolumeOutput struct { // The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI // name that initiators can use to connect to the target. TargetARN *string // The Amazon Resource Name (ARN) of the configured volume. VolumeARN *string // The size of the volume in bytes. VolumeSizeInBytes int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type CreateTapePoolInput ¶
type CreateTapePoolInput struct { // The name of the new custom tape pool. // // This member is required. PoolName *string // The storage class that is associated with the new custom pool. When you use your // backup application to eject the tape, the tape is archived directly into the // storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the // pool. // // This member is required. StorageClass types.TapeStorageClass // Tape retention lock time is set in days. Tape retention lock can be enabled for // up to 100 years (36,500 days). RetentionLockTimeInDays *int32 // Tape retention lock can be configured in two modes. When configured in // governance mode, AWS accounts with specific IAM permissions are authorized to // remove the tape retention lock from archived virtual tapes. When configured in // compliance mode, the tape retention lock cannot be removed by any user, // including the root AWS account. RetentionLockType types.RetentionLockType // A list of up to 50 tags that can be assigned to tape pool. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag }
type CreateTapePoolOutput ¶
type CreateTapePoolOutput struct { // The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use // the ListTapePools operation to return a list of tape pools for your account and // AWS Region. PoolARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTapeWithBarcodeInput ¶
type CreateTapeWithBarcodeInput struct { // The unique Amazon Resource Name (ARN) that represents the gateway to associate // the virtual tape with. Use the ListGateways operation to return a list of // gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The barcode that you want to assign to the tape. Barcodes cannot be reused. This // includes barcodes used for tapes that have been deleted. // // This member is required. TapeBarcode *string // The size, in bytes, of the virtual tape that you want to create. The size must // be aligned by gigabyte (102410241024 bytes). // // This member is required. TapeSizeInBytes *int64 // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the S3 storage class that is associated with the pool. // When you use your backup application to eject the tape, the tape is archived // directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds // to the pool. Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string // A list of up to 50 tags that can be assigned to a virtual tape that has a // barcode. Each tag is a key-value pair. Valid characters for key and value are // letters, spaces, and numbers representable in UTF-8 format, and the following // special characters: + - = . _ : / @. The maximum length of a tag's key is 128 // characters, and the maximum length for a tag's value is 256. Tags []types.Tag // Set to TRUE if the tape you are creating is to be configured as a // write-once-read-many (WORM) tape. Worm bool }
CreateTapeWithBarcodeInput
type CreateTapeWithBarcodeOutput ¶
type CreateTapeWithBarcodeOutput struct { // A unique Amazon Resource Name (ARN) that represents the virtual tape that was // created. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateTapeOutput
type CreateTapesInput ¶
type CreateTapesInput struct { // A unique identifier that you use to retry a request. If you retry a request, use // the same ClientToken you specified in the initial request. Using the same // ClientToken prevents creating the tape multiple times. // // This member is required. ClientToken *string // The unique Amazon Resource Name (ARN) that represents the gateway to associate // the virtual tapes with. Use the ListGateways operation to return a list of // gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The number of virtual tapes that you want to create. // // This member is required. NumTapesToCreate *int32 // A prefix that you append to the barcode of the virtual tape you are creating. // This prefix makes the barcode unique. The prefix must be 1 to 4 characters in // length and must be one of the uppercase letters from A to Z. // // This member is required. TapeBarcodePrefix *string // The size, in bytes, of the virtual tapes that you want to create. The size must // be aligned by gigabyte (102410241024 bytes). // // This member is required. TapeSizeInBytes *int64 // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string // The ID of the pool that you want to add your tape to for archiving. The tape in // this pool is archived in the S3 storage class that is associated with the pool. // When you use your backup application to eject the tape, the tape is archived // directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that // corresponds to the pool. Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string // A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag // Set to TRUE if the tape you are creating is to be configured as a // write-once-read-many (WORM) tape. Worm bool }
CreateTapesInput
type CreateTapesOutput ¶
type CreateTapesOutput struct { // A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes // that were created. TapeARNs []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateTapeOutput
type DeleteAutomaticTapeCreationPolicyInput ¶
type DeleteAutomaticTapeCreationPolicyInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DeleteAutomaticTapeCreationPolicyOutput ¶
type DeleteAutomaticTapeCreationPolicyOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteBandwidthRateLimitInput ¶
type DeleteBandwidthRateLimitInput struct { // One of the BandwidthType values that indicates the gateway bandwidth rate limit // to delete. Valid Values: UPLOAD | DOWNLOAD | ALL // // This member is required. BandwidthType *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the following fields:
* DeleteBandwidthRateLimitInput$BandwidthType
type DeleteBandwidthRateLimitOutput ¶
type DeleteBandwidthRateLimitOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
type DeleteChapCredentialsInput ¶
type DeleteChapCredentialsInput struct { // The iSCSI initiator that connects to the target. // // This member is required. InitiatorName *string // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for // specified VolumeARN. // // This member is required. TargetARN *string }
A JSON object containing one or more of the following fields:
* DeleteChapCredentialsInput$InitiatorName
* DeleteChapCredentialsInput$TargetARN
type DeleteChapCredentialsOutput ¶
type DeleteChapCredentialsOutput struct { // The iSCSI initiator that connects to the target. InitiatorName *string // The Amazon Resource Name (ARN) of the target. TargetARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DeleteFileShareInput ¶
type DeleteFileShareInput struct { // The Amazon Resource Name (ARN) of the file share to be deleted. // // This member is required. *string // If this value is set to true, the operation deletes a file share immediately and // aborts all data uploads to AWS. Otherwise, the file share is not deleted until // all data is uploaded to AWS. This process aborts the data upload process, and // the file share enters the FORCE_DELETING status. Valid Values: true | false bool }
DeleteFileShareInput
type DeleteFileShareOutput ¶
type DeleteFileShareOutput struct { // The Amazon Resource Name (ARN) of the deleted file share. *string // Metadata pertaining to the operation's result. middleware.Metadata }
DeleteFileShareOutput
type DeleteGatewayInput ¶
type DeleteGatewayInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the ID of the gateway to delete.
type DeleteGatewayOutput ¶
type DeleteGatewayOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the ID of the deleted gateway.
type DeleteSnapshotScheduleInput ¶
type DeleteSnapshotScheduleInput struct { // The volume which snapshot schedule to delete. // // This member is required. VolumeARN *string }
type DeleteSnapshotScheduleOutput ¶
type DeleteSnapshotScheduleOutput struct { // The volume which snapshot schedule was deleted. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTapeArchiveInput ¶
type DeleteTapeArchiveInput struct { // The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual // tape shelf (VTS). // // This member is required. TapeARN *string // Set to TRUE to delete an archived tape that belongs to a custom pool with tape // retention lock. Only archived tapes with tape retention lock set to governance // can be deleted. Archived tapes with tape retention lock set to compliance can't // be deleted. BypassGovernanceRetention bool }
DeleteTapeArchiveInput
type DeleteTapeArchiveOutput ¶
type DeleteTapeArchiveOutput struct { // The Amazon Resource Name (ARN) of the virtual tape that was deleted from the // virtual tape shelf (VTS). TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DeleteTapeArchiveOutput
type DeleteTapeInput ¶
type DeleteTapeInput struct { // The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to // delete is associated with. Use the ListGateways operation to return a list of // gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the virtual tape to delete. // // This member is required. TapeARN *string // Set to TRUE to delete an archived tape that belongs to a custom pool with tape // retention lock. Only archived tapes with tape retention lock set to governance // can be deleted. Archived tapes with tape retention lock set to compliance can't // be deleted. BypassGovernanceRetention bool }
DeleteTapeInput
type DeleteTapeOutput ¶
type DeleteTapeOutput struct { // The Amazon Resource Name (ARN) of the deleted virtual tape. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DeleteTapeOutput
type DeleteTapePoolInput ¶
type DeleteTapePoolInput struct { // The Amazon Resource Name (ARN) of the custom tape pool to delete. // // This member is required. PoolARN *string }
type DeleteTapePoolOutput ¶
type DeleteTapePoolOutput struct { // The Amazon Resource Name (ARN) of the custom tape pool being deleted. PoolARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteVolumeInput ¶
type DeleteVolumeInput struct { // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes. // // This member is required. VolumeARN *string }
A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
type DeleteVolumeOutput ¶
type DeleteVolumeOutput struct { // The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the // same ARN you provided in the request. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.
type DescribeAvailabilityMonitorTestInput ¶
type DescribeAvailabilityMonitorTestInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DescribeAvailabilityMonitorTestOutput ¶
type DescribeAvailabilityMonitorTestOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The time the High Availability monitoring test was started. If a test hasn't // been performed, the value of this field is null. StartTime *time.Time // The status of the High Availability monitoring test. If a test hasn't been // performed, the value of this field is null. Status types.AvailabilityMonitorTestStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeBandwidthRateLimitInput ¶
type DescribeBandwidthRateLimitInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type DescribeBandwidthRateLimitOutput ¶
type DescribeBandwidthRateLimitOutput struct { // The average download bandwidth rate limit in bits per second. This field does // not appear in the response if the download rate limit is not set. AverageDownloadRateLimitInBitsPerSec *int64 // The average upload bandwidth rate limit in bits per second. This field does not // appear in the response if the upload rate limit is not set. AverageUploadRateLimitInBitsPerSec *int64 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DescribeBandwidthRateLimitScheduleInput ¶
type DescribeBandwidthRateLimitScheduleInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DescribeBandwidthRateLimitScheduleOutput ¶
type DescribeBandwidthRateLimitScheduleOutput struct { // An array that contains the bandwidth rate limit intervals for a tape or volume // gateway. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeCacheInput ¶
type DescribeCacheInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DescribeCacheOutput ¶
type DescribeCacheOutput struct { // The amount of cache in bytes allocated to a gateway. CacheAllocatedInBytes int64 // The file share's contribution to the overall percentage of the gateway's cache // that has not been persisted to AWS. The sample is taken at the end of the // reporting period. CacheDirtyPercentage float64 // Percent of application read operations from the file shares that are served from // cache. The sample is taken at the end of the reporting period. CacheHitPercentage float64 // Percent of application read operations from the file shares that are not served // from cache. The sample is taken at the end of the reporting period. CacheMissPercentage float64 // Percent use of the gateway's cache storage. This metric applies only to the // gateway-cached volume setup. The sample is taken at the end of the reporting // period. CacheUsedPercentage float64 // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You // can get the disk IDs from the ListLocalDisks API. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeCachediSCSIVolumesInput ¶
type DescribeCachediSCSIVolumesInput struct { // An array of strings where each string represents the Amazon Resource Name (ARN) // of a cached volume. All of the specified cached volumes must be from the same // gateway. Use ListVolumes to get volume ARNs for a gateway. // // This member is required. VolumeARNs []string }
type DescribeCachediSCSIVolumesOutput ¶
type DescribeCachediSCSIVolumesOutput struct { // An array of objects where each object contains metadata about one cached volume. CachediSCSIVolumes []types.CachediSCSIVolume // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DescribeChapCredentialsInput ¶
type DescribeChapCredentialsInput struct { // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for // specified VolumeARN. // // This member is required. TargetARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
type DescribeChapCredentialsOutput ¶
type DescribeChapCredentialsOutput struct { // An array of ChapInfo objects that represent CHAP credentials. Each object in the // array contains CHAP credential information for one target-initiator pair. If no // CHAP credentials are set, an empty array is returned. CHAP credential // information is provided in a JSON object with the following fields: // // * // InitiatorName: The iSCSI initiator that connects to the target. // // * // SecretToAuthenticateInitiator: The secret key that the initiator (for example, // the Windows client) must provide to participate in mutual CHAP with the // target. // // * SecretToAuthenticateTarget: The secret key that the target must // provide to participate in mutual CHAP with the initiator (e.g. Windows // client). // // * TargetARN: The Amazon Resource Name (ARN) of the storage volume. ChapCredentials []types.ChapInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DescribeGatewayInformationInput ¶
type DescribeGatewayInformationInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the ID of the gateway.
type DescribeGatewayInformationOutput ¶
type DescribeGatewayInformationOutput struct { // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used // to monitor events in the gateway. CloudWatchLogGroupARN *string // Date after which this gateway will not receive software updates for new features // and bug fixes. DeprecationDate *string // The ID of the Amazon EC2 instance that was used to launch the gateway. Ec2InstanceId *string // The AWS Region where the Amazon EC2 instance is located. Ec2InstanceRegion *string // The type of endpoint for your gateway. Valid Values: STANDARD | FIPS EndpointType *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The unique identifier assigned to your gateway during activation. This ID // becomes part of the gateway Amazon Resource Name (ARN), which you use as input // for other operations. GatewayId *string // The name you configured for your gateway. GatewayName *string // A NetworkInterface array that contains descriptions of the gateway network // interfaces. GatewayNetworkInterfaces []types.NetworkInterface // A value that indicates the operating state of the gateway. GatewayState *string // A value that indicates the time zone configured for the gateway. GatewayTimezone *string // The type of the gateway. GatewayType *string // The type of hypervisor environment used by the host. HostEnvironment types.HostEnvironment // The date on which the last software update was applied to the gateway. If the // gateway has never been updated, this field does not return a value in the // response. LastSoftwareUpdate *string // The date on which an update to the gateway is available. This date is in the // time zone of the gateway. If the gateway is not available for an update this // field is not returned in the response. NextUpdateAvailabilityDate *string // Date after which this gateway will not receive software updates for new // features. SoftwareUpdatesEndDate *string // A list of up to 50 tags assigned to the gateway, sorted alphabetically by key // name. Each tag is a key-value pair. For a gateway with more than 10 tags // assigned, you can view all tags using the ListTagsForResource API operation. Tags []types.Tag // The configuration settings for the virtual private cloud (VPC) endpoint for your // gateway. VPCEndpoint *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DescribeMaintenanceStartTimeInput ¶
type DescribeMaintenanceStartTimeInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type DescribeMaintenanceStartTimeOutput ¶
type DescribeMaintenanceStartTimeOutput struct { // The day of the month component of the maintenance start time represented as an // ordinal number from 1 to 28, where 1 represents the first day of the month and // 28 represents the last day of the month. DayOfMonth *int32 // An ordinal number between 0 and 6 that represents the day of the week, where 0 // represents Sunday and 6 represents Saturday. The day of week is in the time zone // of the gateway. DayOfWeek *int32 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The hour component of the maintenance start time represented as hh, where hh is // the hour (0 to 23). The hour of the day is in the time zone of the gateway. HourOfDay *int32 // The minute component of the maintenance start time represented as mm, where mm // is the minute (0 to 59). The minute of the hour is in the time zone of the // gateway. MinuteOfHour *int32 // A value that indicates the time zone that is set for the gateway. The start time // and day of week specified should be in the time zone of the gateway. Timezone *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
* DescribeMaintenanceStartTimeOutput$DayOfMonth
* DescribeMaintenanceStartTimeOutput$DayOfWeek
* DescribeMaintenanceStartTimeOutput$HourOfDay
* DescribeMaintenanceStartTimeOutput$MinuteOfHour
* DescribeMaintenanceStartTimeOutput$Timezone
type DescribeNFSFileSharesInput ¶
type DescribeNFSFileSharesInput struct { // An array containing the Amazon Resource Name (ARN) of each file share to be // described. // // This member is required. []string }
DescribeNFSFileSharesInput
type DescribeNFSFileSharesOutput ¶
type DescribeNFSFileSharesOutput struct { // An array containing a description for each requested file share. []types.NFSFileShareInfo // Metadata pertaining to the operation's result. middleware.Metadata }
DescribeNFSFileSharesOutput
type DescribeSMBFileSharesInput ¶
type DescribeSMBFileSharesInput struct { // An array containing the Amazon Resource Name (ARN) of each file share to be // described. // // This member is required. []string }
DescribeSMBFileSharesInput
type DescribeSMBFileSharesOutput ¶
type DescribeSMBFileSharesOutput struct { // An array containing a description for each requested file share. []types.SMBFileShareInfo // Metadata pertaining to the operation's result. middleware.Metadata }
DescribeSMBFileSharesOutput
type DescribeSMBSettingsInput ¶
type DescribeSMBSettingsInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DescribeSMBSettingsOutput ¶
type DescribeSMBSettingsOutput struct { // Indicates the status of a gateway that is a member of the Active Directory // domain. // // * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to // an authentication error. // // * DETACHED: Indicates that gateway is not joined to a // domain. // // * JOINED: Indicates that the gateway has successfully joined a // domain. // // * JOINING: Indicates that a JoinDomain operation is in progress. // // * // NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or // connectivity error. // // * TIMEOUT: Indicates that the JoinDomain operation failed // because the operation didn't complete within the allotted time. // // * // UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another // type of error. ActiveDirectoryStatus types.ActiveDirectoryStatus // The name of the domain that the gateway is joined to. DomainName *string // The shares on this gateway appear when listing shares. *bool // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // This value is true if a password for the guest user smbguest is set, otherwise // false. Valid Values: true | false SMBGuestPasswordSet *bool // The type of security strategy that was specified for file gateway. // // * // ClientSpecified: If you use this option, requests are established based on what // is negotiated by the client. This option is recommended when you want to // maximize compatibility across different clients in your environment. // // * // MandatorySigning: If you use this option, file gateway only allows connections // from SMBv2 or SMBv3 clients that have signing enabled. This option works with // SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. // // * // MandatoryEncryption: If you use this option, file gateway only allows // connections from SMBv3 clients that have encryption enabled. This option is // highly recommended for environments that handle sensitive data. This option // works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. SMBSecurityStrategy types.SMBSecurityStrategy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeSnapshotScheduleInput ¶
type DescribeSnapshotScheduleInput struct { // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes. // // This member is required. VolumeARN *string }
A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
type DescribeSnapshotScheduleOutput ¶
type DescribeSnapshotScheduleOutput struct { // The snapshot description. Description *string // The number of hours between snapshots. RecurrenceInHours *int32 // The hour of the day at which the snapshot schedule begins represented as hh, // where hh is the hour (0 to 23). The hour of the day is in the time zone of the // gateway. StartAt *int32 // A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags // assigned, you can view all tags using the ListTagsForResource API operation. Tags []types.Tag // A value that indicates the time zone of the gateway. Timezone *string // The Amazon Resource Name (ARN) of the volume that was specified in the request. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStorediSCSIVolumesInput ¶
type DescribeStorediSCSIVolumesInput struct { // An array of strings where each string represents the Amazon Resource Name (ARN) // of a stored volume. All of the specified stored volumes must be from the same // gateway. Use ListVolumes to get volume ARNs for a gateway. // // This member is required. VolumeARNs []string }
A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
type DescribeStorediSCSIVolumesOutput ¶
type DescribeStorediSCSIVolumesOutput struct { // Describes a single unit of output from DescribeStorediSCSIVolumes. The following // fields are returned: // // * ChapEnabled: Indicates whether mutual CHAP is enabled // for the iSCSI target. // // * LunNumber: The logical disk number. // // * // NetworkInterfaceId: The network interface ID of the stored volume that initiator // use to map the stored volume as an iSCSI target. // // * NetworkInterfacePort: The // port used to communicate with iSCSI targets. // // * PreservedExistingData: Indicates // when the stored volume was created, existing data on the underlying local disk // was preserved. // // * SourceSnapshotId: If the stored volume was created from a // snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. // Otherwise, this field is not included. // // * StorediSCSIVolumes: An array of // StorediSCSIVolume objects where each object contains metadata about one stored // volume. // // * TargetARN: The Amazon Resource Name (ARN) of the volume target. // // * // VolumeARN: The Amazon Resource Name (ARN) of the stored volume. // // * VolumeDiskId: // The disk ID of the local disk that was specified in the CreateStorediSCSIVolume // operation. // // * VolumeId: The unique identifier of the storage volume, e.g. // vol-1122AABB. // // * VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that // represents a collection of iSCSI attributes for one stored volume. // // * // VolumeProgress: Represents the percentage complete if the volume is restoring or // bootstrapping that represents the percent of data transferred. This field does // not appear in the response if the stored volume is not restoring or // bootstrapping. // // * VolumeSizeInBytes: The size of the volume in bytes. // // * // VolumeStatus: One of the VolumeStatus values that indicates the state of the // volume. // // * VolumeType: One of the enumeration values describing the type of the // volume. Currently, only STORED volumes are supported. StorediSCSIVolumes []types.StorediSCSIVolume // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeTapeArchivesAPIClient ¶
type DescribeTapeArchivesAPIClient interface { DescribeTapeArchives(context.Context, *DescribeTapeArchivesInput, ...func(*Options)) (*DescribeTapeArchivesOutput, error) }
DescribeTapeArchivesAPIClient is a client that implements the DescribeTapeArchives operation.
type DescribeTapeArchivesInput ¶
type DescribeTapeArchivesInput struct { // Specifies that the number of virtual tapes described be limited to the specified // number. Limit *int32 // An opaque string that indicates the position at which to begin describing // virtual tapes. Marker *string // Specifies one or more unique Amazon Resource Names (ARNs) that represent the // virtual tapes you want to describe. TapeARNs []string }
DescribeTapeArchivesInput
type DescribeTapeArchivesOutput ¶
type DescribeTapeArchivesOutput struct { // An opaque string that indicates the position at which the virtual tapes that // were fetched for description ended. Use this marker in your next request to // fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there // are no more virtual tapes to describe, this field does not appear in the // response. Marker *string // An array of virtual tape objects in the virtual tape shelf (VTS). The // description includes of the Amazon Resource Name (ARN) of the virtual tapes. The // information returned includes the Amazon Resource Names (ARNs) of the tapes, // size of the tapes, status of the tapes, progress of the description, and tape // barcode. TapeArchives []types.TapeArchive // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeTapeArchivesOutput
type DescribeTapeArchivesPaginator ¶
type DescribeTapeArchivesPaginator struct {
// contains filtered or unexported fields
}
DescribeTapeArchivesPaginator is a paginator for DescribeTapeArchives
func NewDescribeTapeArchivesPaginator ¶
func NewDescribeTapeArchivesPaginator(client DescribeTapeArchivesAPIClient, params *DescribeTapeArchivesInput, optFns ...func(*DescribeTapeArchivesPaginatorOptions)) *DescribeTapeArchivesPaginator
NewDescribeTapeArchivesPaginator returns a new DescribeTapeArchivesPaginator
func (*DescribeTapeArchivesPaginator) HasMorePages ¶
func (p *DescribeTapeArchivesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeTapeArchivesPaginator) NextPage ¶
func (p *DescribeTapeArchivesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapeArchivesOutput, error)
NextPage retrieves the next DescribeTapeArchives page.
type DescribeTapeArchivesPaginatorOptions ¶
type DescribeTapeArchivesPaginatorOptions struct { // Specifies that the number of virtual tapes described be limited to the specified // number. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeTapeArchivesPaginatorOptions is the paginator options for DescribeTapeArchives
type DescribeTapeRecoveryPointsAPIClient ¶
type DescribeTapeRecoveryPointsAPIClient interface { DescribeTapeRecoveryPoints(context.Context, *DescribeTapeRecoveryPointsInput, ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error) }
DescribeTapeRecoveryPointsAPIClient is a client that implements the DescribeTapeRecoveryPoints operation.
type DescribeTapeRecoveryPointsInput ¶
type DescribeTapeRecoveryPointsInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // Specifies that the number of virtual tape recovery points that are described be // limited to the specified number. Limit *int32 // An opaque string that indicates the position at which to begin describing the // virtual tape recovery points. Marker *string }
DescribeTapeRecoveryPointsInput
type DescribeTapeRecoveryPointsOutput ¶
type DescribeTapeRecoveryPointsOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // An opaque string that indicates the position at which the virtual tape recovery // points that were listed for description ended. Use this marker in your next // request to list the next set of virtual tape recovery points in the list. If // there are no more recovery points to describe, this field does not appear in the // response. Marker *string // An array of TapeRecoveryPointInfos that are available for the specified gateway. TapeRecoveryPointInfos []types.TapeRecoveryPointInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeTapeRecoveryPointsOutput
type DescribeTapeRecoveryPointsPaginator ¶
type DescribeTapeRecoveryPointsPaginator struct {
// contains filtered or unexported fields
}
DescribeTapeRecoveryPointsPaginator is a paginator for DescribeTapeRecoveryPoints
func NewDescribeTapeRecoveryPointsPaginator ¶
func NewDescribeTapeRecoveryPointsPaginator(client DescribeTapeRecoveryPointsAPIClient, params *DescribeTapeRecoveryPointsInput, optFns ...func(*DescribeTapeRecoveryPointsPaginatorOptions)) *DescribeTapeRecoveryPointsPaginator
NewDescribeTapeRecoveryPointsPaginator returns a new DescribeTapeRecoveryPointsPaginator
func (*DescribeTapeRecoveryPointsPaginator) HasMorePages ¶
func (p *DescribeTapeRecoveryPointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeTapeRecoveryPointsPaginator) NextPage ¶
func (p *DescribeTapeRecoveryPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error)
NextPage retrieves the next DescribeTapeRecoveryPoints page.
type DescribeTapeRecoveryPointsPaginatorOptions ¶
type DescribeTapeRecoveryPointsPaginatorOptions struct { // Specifies that the number of virtual tape recovery points that are described be // limited to the specified number. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeTapeRecoveryPointsPaginatorOptions is the paginator options for DescribeTapeRecoveryPoints
type DescribeTapesAPIClient ¶
type DescribeTapesAPIClient interface { DescribeTapes(context.Context, *DescribeTapesInput, ...func(*Options)) (*DescribeTapesOutput, error) }
DescribeTapesAPIClient is a client that implements the DescribeTapes operation.
type DescribeTapesInput ¶
type DescribeTapesInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // Specifies that the number of virtual tapes described be limited to the specified // number. Amazon Web Services may impose its own limit, if this field is not set. Limit *int32 // A marker value, obtained in a previous call to DescribeTapes. This marker // indicates which page of results to retrieve. If not specified, the first page of // results is retrieved. Marker *string // Specifies one or more unique Amazon Resource Names (ARNs) that represent the // virtual tapes you want to describe. If this parameter is not specified, Tape // gateway returns a description of all virtual tapes associated with the specified // gateway. TapeARNs []string }
DescribeTapesInput
type DescribeTapesOutput ¶
type DescribeTapesOutput struct { // An opaque string which can be used as part of a subsequent DescribeTapes call to // retrieve the next page of results. If a response does not contain a marker, then // there are no more results to be retrieved. Marker *string // An array of virtual tape descriptions. Tapes []types.Tape // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeTapesOutput
type DescribeTapesPaginator ¶
type DescribeTapesPaginator struct {
// contains filtered or unexported fields
}
DescribeTapesPaginator is a paginator for DescribeTapes
func NewDescribeTapesPaginator ¶
func NewDescribeTapesPaginator(client DescribeTapesAPIClient, params *DescribeTapesInput, optFns ...func(*DescribeTapesPaginatorOptions)) *DescribeTapesPaginator
NewDescribeTapesPaginator returns a new DescribeTapesPaginator
func (*DescribeTapesPaginator) HasMorePages ¶
func (p *DescribeTapesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeTapesPaginator) NextPage ¶
func (p *DescribeTapesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTapesOutput, error)
NextPage retrieves the next DescribeTapes page.
type DescribeTapesPaginatorOptions ¶
type DescribeTapesPaginatorOptions struct { // Specifies that the number of virtual tapes described be limited to the specified // number. Amazon Web Services may impose its own limit, if this field is not set. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeTapesPaginatorOptions is the paginator options for DescribeTapes
type DescribeUploadBufferInput ¶
type DescribeUploadBufferInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type DescribeUploadBufferOutput ¶
type DescribeUploadBufferOutput struct { // An array of the gateway's local disk IDs that are configured as working storage. // Each local disk ID is specified as a string (minimum length of 1 and maximum // length of 300). If no local disks are configured as working storage, then the // DiskIds array is empty. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The total number of bytes allocated in the gateway's as upload buffer. UploadBufferAllocatedInBytes int64 // The total number of bytes being used in the gateway's upload buffer. UploadBufferUsedInBytes int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeVTLDevicesAPIClient ¶
type DescribeVTLDevicesAPIClient interface { DescribeVTLDevices(context.Context, *DescribeVTLDevicesInput, ...func(*Options)) (*DescribeVTLDevicesOutput, error) }
DescribeVTLDevicesAPIClient is a client that implements the DescribeVTLDevices operation.
type DescribeVTLDevicesInput ¶
type DescribeVTLDevicesInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // Specifies that the number of VTL devices described be limited to the specified // number. Limit *int32 // An opaque string that indicates the position at which to begin describing the // VTL devices. Marker *string // An array of strings, where each string represents the Amazon Resource Name (ARN) // of a VTL device. All of the specified VTL devices must be from the same gateway. // If no VTL devices are specified, the result will contain all devices on the // specified gateway. VTLDeviceARNs []string }
DescribeVTLDevicesInput
type DescribeVTLDevicesOutput ¶
type DescribeVTLDevicesOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // An opaque string that indicates the position at which the VTL devices that were // fetched for description ended. Use the marker in your next request to fetch the // next set of VTL devices in the list. If there are no more VTL devices to // describe, this field does not appear in the response. Marker *string // An array of VTL device objects composed of the Amazon Resource Name (ARN) of the // VTL devices. VTLDevices []types.VTLDevice // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeVTLDevicesOutput
type DescribeVTLDevicesPaginator ¶
type DescribeVTLDevicesPaginator struct {
// contains filtered or unexported fields
}
DescribeVTLDevicesPaginator is a paginator for DescribeVTLDevices
func NewDescribeVTLDevicesPaginator ¶
func NewDescribeVTLDevicesPaginator(client DescribeVTLDevicesAPIClient, params *DescribeVTLDevicesInput, optFns ...func(*DescribeVTLDevicesPaginatorOptions)) *DescribeVTLDevicesPaginator
NewDescribeVTLDevicesPaginator returns a new DescribeVTLDevicesPaginator
func (*DescribeVTLDevicesPaginator) HasMorePages ¶
func (p *DescribeVTLDevicesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeVTLDevicesPaginator) NextPage ¶
func (p *DescribeVTLDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeVTLDevicesOutput, error)
NextPage retrieves the next DescribeVTLDevices page.
type DescribeVTLDevicesPaginatorOptions ¶
type DescribeVTLDevicesPaginatorOptions struct { // Specifies that the number of VTL devices described be limited to the specified // number. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeVTLDevicesPaginatorOptions is the paginator options for DescribeVTLDevices
type DescribeWorkingStorageInput ¶
type DescribeWorkingStorageInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type DescribeWorkingStorageOutput ¶
type DescribeWorkingStorageOutput struct { // An array of the gateway's local disk IDs that are configured as working storage. // Each local disk ID is specified as a string (minimum length of 1 and maximum // length of 300). If no local disks are configured as working storage, then the // DiskIds array is empty. DiskIds []string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The total working storage in bytes allocated for the gateway. If no working // storage is configured for the gateway, this field returns 0. WorkingStorageAllocatedInBytes int64 // The total working storage in bytes in use by the gateway. If no working storage // is configured for the gateway, this field returns 0. WorkingStorageUsedInBytes int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type DetachVolumeInput ¶
type DetachVolumeInput struct { // The Amazon Resource Name (ARN) of the volume to detach from the gateway. // // This member is required. VolumeARN *string // Set to true to forcibly remove the iSCSI connection of the target volume and // detach the volume. The default is false. If this value is set to false, you must // manually disconnect the iSCSI connection from the target volume. Valid Values: // true | false ForceDetach *bool }
AttachVolumeInput
type DetachVolumeOutput ¶
type DetachVolumeOutput struct { // The Amazon Resource Name (ARN) of the volume that was detached. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
AttachVolumeOutput
type DisableGatewayInput ¶
type DisableGatewayInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
DisableGatewayInput
type DisableGatewayOutput ¶
type DisableGatewayOutput struct { // The unique Amazon Resource Name (ARN) of the disabled gateway. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DisableGatewayOutput
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type JoinDomainInput ¶
type JoinDomainInput struct { // The name of the domain that you want the gateway to join. // // This member is required. DomainName *string // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // Sets the password of the user who has permission to add the gateway to the // Active Directory domain. // // This member is required. Password *string // Sets the user name of user who has permission to add the gateway to the Active // Directory domain. The domain user account should be enabled to join computers to // the domain. For example, you can use the domain administrator account or an // account with delegated permissions to join computers to the domain. // // This member is required. UserName *string // List of IPv4 addresses, NetBIOS names, or host names of your domain server. If // you need to specify the port number include it after the colon (“:”). For // example, mydc.mydomain.com:389. DomainControllers []string // The organizational unit (OU) is a container in an Active Directory that can hold // users, groups, computers, and other OUs and this parameter specifies the OU that // the gateway will join within the AD domain. OrganizationalUnit *string // Specifies the time in seconds, in which the JoinDomain operation must complete. // The default is 20 seconds. TimeoutInSeconds *int32 }
JoinDomainInput
type JoinDomainOutput ¶
type JoinDomainOutput struct { // Indicates the status of the gateway as a member of the Active Directory // domain. // // * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to // an authentication error. // // * DETACHED: Indicates that gateway is not joined to a // domain. // // * JOINED: Indicates that the gateway has successfully joined a // domain. // // * JOINING: Indicates that a JoinDomain operation is in progress. // // * // NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or // connectivity error. // // * TIMEOUT: Indicates that the JoinDomain operation failed // because the operation didn't complete within the allotted time. // // * // UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another // type of error. ActiveDirectoryStatus types.ActiveDirectoryStatus // The unique Amazon Resource Name (ARN) of the gateway that joined the domain. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
JoinDomainOutput
type ListAutomaticTapeCreationPoliciesInput ¶
type ListAutomaticTapeCreationPoliciesInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string }
type ListAutomaticTapeCreationPoliciesOutput ¶
type ListAutomaticTapeCreationPoliciesOutput struct { // Gets a listing of information about the gateway's automatic tape creation // policies, including the automatic tape creation rules and the gateway that is // using the policies. AutomaticTapeCreationPolicyInfos []types.AutomaticTapeCreationPolicyInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListFileSharesAPIClient ¶
type ListFileSharesAPIClient interface { context.Context, *ListFileSharesInput, ...func(*Options)) (*ListFileSharesOutput, error) }(
ListFileSharesAPIClient is a client that implements the ListFileShares operation.
type ListFileSharesInput ¶
type ListFileSharesInput struct { // The Amazon Resource Name (ARN) of the gateway whose file shares you want to // list. If this field is not present, all file shares under your account are // listed. *string // The maximum number of file shares to return in the response. The value must be // an integer with a value greater than zero. Optional. *int32 // Opaque pagination token returned from a previous ListFileShares operation. If // present, Marker specifies where to continue the list from after a previous call // to ListFileShares. Optional. *string }
ListFileShareInput
type ListFileSharesOutput ¶
type ListFileSharesOutput struct { // An array of information about the file gateway's file shares. []types.FileShareInfo // If the request includes Marker, the response returns that value in this field. *string // If a value is present, there are more file shares to return. In a subsequent // request, use NextMarker as the value for Marker to retrieve the next set of file // shares. *string // Metadata pertaining to the operation's result. middleware.Metadata }
ListFileShareOutput
type ListFileSharesPaginator ¶
type ListFileSharesPaginator struct {
// contains filtered or unexported fields
}
ListFileSharesPaginator is a paginator for ListFileShares
func NewListFileSharesPaginator ¶
func NewListFileSharesPaginator(client ListFileSharesAPIClient, params *ListFileSharesInput, optFns ...func(*ListFileSharesPaginatorOptions)) *ListFileSharesPaginator
NewListFileSharesPaginator returns a new ListFileSharesPaginator
func (*ListFileSharesPaginator) HasMorePages ¶
func (p *ListFileSharesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFileSharesPaginator) NextPage ¶
func (p *ListFileSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFileSharesOutput, error)
NextPage retrieves the next ListFileShares page.
type ListFileSharesPaginatorOptions ¶
type ListFileSharesPaginatorOptions struct { // The maximum number of file shares to return in the response. The value must be // an integer with a value greater than zero. Optional. int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. bool }
ListFileSharesPaginatorOptions is the paginator options for ListFileShares
type ListGatewaysAPIClient ¶
type ListGatewaysAPIClient interface { ListGateways(context.Context, *ListGatewaysInput, ...func(*Options)) (*ListGatewaysOutput, error) }
ListGatewaysAPIClient is a client that implements the ListGateways operation.
type ListGatewaysInput ¶
type ListGatewaysInput struct { // Specifies that the list of gateways returned be limited to the specified number // of items. Limit *int32 // An opaque string that indicates the position at which to begin the returned list // of gateways. Marker *string }
A JSON object containing zero or more of the following fields:
* ListGatewaysInput$Limit
* ListGatewaysInput$Marker
type ListGatewaysOutput ¶
type ListGatewaysOutput struct { // An array of GatewayInfo objects. Gateways []types.GatewayInfo // Use the marker in your next request to fetch the next set of gateways in the // list. If there are no more gateways to list, this field does not appear in the // response. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListGatewaysPaginator ¶
type ListGatewaysPaginator struct {
// contains filtered or unexported fields
}
ListGatewaysPaginator is a paginator for ListGateways
func NewListGatewaysPaginator ¶
func NewListGatewaysPaginator(client ListGatewaysAPIClient, params *ListGatewaysInput, optFns ...func(*ListGatewaysPaginatorOptions)) *ListGatewaysPaginator
NewListGatewaysPaginator returns a new ListGatewaysPaginator
func (*ListGatewaysPaginator) HasMorePages ¶
func (p *ListGatewaysPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListGatewaysPaginator) NextPage ¶
func (p *ListGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewaysOutput, error)
NextPage retrieves the next ListGateways page.
type ListGatewaysPaginatorOptions ¶
type ListGatewaysPaginatorOptions struct { // Specifies that the list of gateways returned be limited to the specified number // of items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListGatewaysPaginatorOptions is the paginator options for ListGateways
type ListLocalDisksInput ¶
type ListLocalDisksInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type ListLocalDisksOutput ¶
type ListLocalDisksOutput struct { // A JSON object containing the following fields: // // * ListLocalDisksOutput$Disks Disks []types.Disk // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceAPIClient ¶
type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) }
ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource for which you want to list tags. // // This member is required. ResourceARN *string // Specifies that the list of tags returned be limited to the specified number of // items. Limit *int32 // An opaque string that indicates the position at which to begin returning the // list of tags. Marker *string }
ListTagsForResourceInput
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // An opaque string that indicates the position at which to stop returning the list // of tags. Marker *string // The Amazon Resource Name (ARN) of the resource for which you want to list tags. ResourceARN *string // An array that contains the tags for the specified resource. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListTagsForResourceOutput
type ListTagsForResourcePaginator ¶
type ListTagsForResourcePaginator struct {
// contains filtered or unexported fields
}
ListTagsForResourcePaginator is a paginator for ListTagsForResource
func NewListTagsForResourcePaginator ¶
func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator
NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator
func (*ListTagsForResourcePaginator) HasMorePages ¶
func (p *ListTagsForResourcePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTagsForResourcePaginator) NextPage ¶
func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
NextPage retrieves the next ListTagsForResource page.
type ListTagsForResourcePaginatorOptions ¶
type ListTagsForResourcePaginatorOptions struct { // Specifies that the list of tags returned be limited to the specified number of // items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource
type ListTapePoolsAPIClient ¶
type ListTapePoolsAPIClient interface { ListTapePools(context.Context, *ListTapePoolsInput, ...func(*Options)) (*ListTapePoolsOutput, error) }
ListTapePoolsAPIClient is a client that implements the ListTapePools operation.
type ListTapePoolsInput ¶
type ListTapePoolsInput struct { // An optional number limit for the tape pools in the list returned by this call. Limit *int32 // A string that indicates the position at which to begin the returned list of tape // pools. Marker *string // The Amazon Resource Name (ARN) of each of the custom tape pools you want to // list. If you don't specify a custom tape pool ARN, the response lists all custom // tape pools. PoolARNs []string }
type ListTapePoolsOutput ¶
type ListTapePoolsOutput struct { // A string that indicates the position at which to begin the returned list of tape // pools. Use the marker in your next request to continue pagination of tape pools. // If there are no more tape pools to list, this element does not appear in the // response body. Marker *string // An array of PoolInfo objects, where each object describes a single custom tape // pool. If there are no custom tape pools, the PoolInfos is an empty array. PoolInfos []types.PoolInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTapePoolsPaginator ¶
type ListTapePoolsPaginator struct {
// contains filtered or unexported fields
}
ListTapePoolsPaginator is a paginator for ListTapePools
func NewListTapePoolsPaginator ¶
func NewListTapePoolsPaginator(client ListTapePoolsAPIClient, params *ListTapePoolsInput, optFns ...func(*ListTapePoolsPaginatorOptions)) *ListTapePoolsPaginator
NewListTapePoolsPaginator returns a new ListTapePoolsPaginator
func (*ListTapePoolsPaginator) HasMorePages ¶
func (p *ListTapePoolsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTapePoolsPaginator) NextPage ¶
func (p *ListTapePoolsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTapePoolsOutput, error)
NextPage retrieves the next ListTapePools page.
type ListTapePoolsPaginatorOptions ¶
type ListTapePoolsPaginatorOptions struct { // An optional number limit for the tape pools in the list returned by this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTapePoolsPaginatorOptions is the paginator options for ListTapePools
type ListTapesAPIClient ¶
type ListTapesAPIClient interface { ListTapes(context.Context, *ListTapesInput, ...func(*Options)) (*ListTapesOutput, error) }
ListTapesAPIClient is a client that implements the ListTapes operation.
type ListTapesInput ¶
type ListTapesInput struct { // An optional number limit for the tapes in the list returned by this call. Limit *int32 // A string that indicates the position at which to begin the returned list of // tapes. Marker *string // The Amazon Resource Name (ARN) of each of the tapes you want to list. If you // don't specify a tape ARN, the response lists all tapes in both your VTL and VTS. TapeARNs []string }
A JSON object that contains one or more of the following fields:
* ListTapesInput$Limit
* ListTapesInput$Marker
* ListTapesInput$TapeARNs
type ListTapesOutput ¶
type ListTapesOutput struct { // A string that indicates the position at which to begin returning the next list // of tapes. Use the marker in your next request to continue pagination of tapes. // If there are no more tapes to list, this element does not appear in the response // body. Marker *string // An array of TapeInfo objects, where each object describes a single tape. If // there are no tapes in the tape library or VTS, then the TapeInfos is an empty // array. TapeInfos []types.TapeInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
* ListTapesOutput$Marker
* ListTapesOutput$VolumeInfos
type ListTapesPaginator ¶
type ListTapesPaginator struct {
// contains filtered or unexported fields
}
ListTapesPaginator is a paginator for ListTapes
func NewListTapesPaginator ¶
func NewListTapesPaginator(client ListTapesAPIClient, params *ListTapesInput, optFns ...func(*ListTapesPaginatorOptions)) *ListTapesPaginator
NewListTapesPaginator returns a new ListTapesPaginator
func (*ListTapesPaginator) HasMorePages ¶
func (p *ListTapesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTapesPaginator) NextPage ¶
func (p *ListTapesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTapesOutput, error)
NextPage retrieves the next ListTapes page.
type ListTapesPaginatorOptions ¶
type ListTapesPaginatorOptions struct { // An optional number limit for the tapes in the list returned by this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTapesPaginatorOptions is the paginator options for ListTapes
type ListVolumeInitiatorsInput ¶
type ListVolumeInitiatorsInput struct { // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes for the gateway. // // This member is required. VolumeARN *string }
ListVolumeInitiatorsInput
type ListVolumeInitiatorsOutput ¶
type ListVolumeInitiatorsOutput struct { // The host names and port numbers of all iSCSI initiators that are connected to // the gateway. Initiators []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListVolumeInitiatorsOutput
type ListVolumeRecoveryPointsInput ¶
type ListVolumeRecoveryPointsInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type ListVolumeRecoveryPointsOutput ¶
type ListVolumeRecoveryPointsOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // An array of VolumeRecoveryPointInfo objects. VolumeRecoveryPointInfos []types.VolumeRecoveryPointInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListVolumesAPIClient ¶
type ListVolumesAPIClient interface { ListVolumes(context.Context, *ListVolumesInput, ...func(*Options)) (*ListVolumesOutput, error) }
ListVolumesAPIClient is a client that implements the ListVolumes operation.
type ListVolumesInput ¶
type ListVolumesInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Specifies that the list of volumes returned be limited to the specified number // of items. Limit *int32 // A string that indicates the position at which to begin the returned list of // volumes. Obtain the marker from the response of a previous List iSCSI Volumes // request. Marker *string }
A JSON object that contains one or more of the following fields:
* ListVolumesInput$Limit
* ListVolumesInput$Marker
type ListVolumesOutput ¶
type ListVolumesOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Use the marker in your next request to continue pagination of iSCSI volumes. If // there are no more volumes to list, this field does not appear in the response // body. Marker *string // An array of VolumeInfo objects, where each object describes an iSCSI volume. If // no volumes are defined for the gateway, then VolumeInfos is an empty array "[]". VolumeInfos []types.VolumeInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
* ListVolumesOutput$Marker
* ListVolumesOutput$VolumeInfos
type ListVolumesPaginator ¶
type ListVolumesPaginator struct {
// contains filtered or unexported fields
}
ListVolumesPaginator is a paginator for ListVolumes
func NewListVolumesPaginator ¶
func NewListVolumesPaginator(client ListVolumesAPIClient, params *ListVolumesInput, optFns ...func(*ListVolumesPaginatorOptions)) *ListVolumesPaginator
NewListVolumesPaginator returns a new ListVolumesPaginator
func (*ListVolumesPaginator) HasMorePages ¶
func (p *ListVolumesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListVolumesPaginator) NextPage ¶
func (p *ListVolumesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVolumesOutput, error)
NextPage retrieves the next ListVolumes page.
type ListVolumesPaginatorOptions ¶
type ListVolumesPaginatorOptions struct { // Specifies that the list of volumes returned be limited to the specified number // of items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListVolumesPaginatorOptions is the paginator options for ListVolumes
type NotifyWhenUploadedInput ¶
type NotifyWhenUploadedInput struct { // The Amazon Resource Name (ARN) of the file share. // // This member is required. *string }
type NotifyWhenUploadedOutput ¶
type NotifyWhenUploadedOutput struct { // The Amazon Resource Name (ARN) of the file share. *string // The randomly generated ID of the notification that was sent. This ID is in UUID // format. NotificationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type RefreshCacheInput ¶
type RefreshCacheInput struct { // The Amazon Resource Name (ARN) of the file share you want to refresh. // // This member is required. *string // A comma-separated list of the paths of folders to refresh in the cache. The // default is ["/"]. The default refreshes objects and folders at the root of the // Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the // file share has access to is refreshed. FolderList []string // A value that specifies whether to recursively refresh folders in the cache. The // refresh includes folders that were in the cache the last time the gateway listed // the folder's contents. If this value set to true, each folder that is listed in // FolderList is recursively updated. Otherwise, subfolders listed in FolderList // are not refreshed. Only objects that are in folders listed directly under // FolderList are found and used for the update. The default is true. Valid Values: // true | false Recursive *bool }
RefreshCacheInput
type RefreshCacheOutput ¶
type RefreshCacheOutput struct { // The Amazon Resource Name (ARN) of the file share. *string // The randomly generated ID of the notification that was sent. This ID is in UUID // format. NotificationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
RefreshCacheOutput
type RemoveTagsFromResourceInput ¶
type RemoveTagsFromResourceInput struct { // The Amazon Resource Name (ARN) of the resource you want to remove the tags from. // // This member is required. ResourceARN *string // The keys of the tags you want to remove from the specified resource. A tag is // composed of a key-value pair. // // This member is required. TagKeys []string }
RemoveTagsFromResourceInput
type RemoveTagsFromResourceOutput ¶
type RemoveTagsFromResourceOutput struct { // The Amazon Resource Name (ARN) of the resource that the tags were removed from. ResourceARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
RemoveTagsFromResourceOutput
type ResetCacheInput ¶
type ResetCacheInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type ResetCacheOutput ¶
type ResetCacheOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type RetrieveTapeArchiveInput ¶
type RetrieveTapeArchiveInput struct { // The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual // tape to. Use the ListGateways operation to return a list of gateways for your // account and AWS Region. You retrieve archived virtual tapes to only one gateway // and the gateway must be a tape gateway. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the // virtual tape shelf (VTS). // // This member is required. TapeARN *string }
RetrieveTapeArchiveInput
type RetrieveTapeArchiveOutput ¶
type RetrieveTapeArchiveOutput struct { // The Amazon Resource Name (ARN) of the retrieved virtual tape. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
RetrieveTapeArchiveOutput
type RetrieveTapeRecoveryPointInput ¶
type RetrieveTapeRecoveryPointInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the virtual tape for which you want to // retrieve the recovery point. // // This member is required. TapeARN *string }
RetrieveTapeRecoveryPointInput
type RetrieveTapeRecoveryPointOutput ¶
type RetrieveTapeRecoveryPointOutput struct { // The Amazon Resource Name (ARN) of the virtual tape for which the recovery point // was retrieved. TapeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
RetrieveTapeRecoveryPointOutput
type SetLocalConsolePasswordInput ¶
type SetLocalConsolePasswordInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The password you want to set for your VM local console. // // This member is required. LocalConsolePassword *string }
SetLocalConsolePasswordInput
type SetLocalConsolePasswordOutput ¶
type SetLocalConsolePasswordOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type SetSMBGuestPasswordInput ¶
type SetSMBGuestPasswordInput struct { // The Amazon Resource Name (ARN) of the file gateway the SMB file share is // associated with. // // This member is required. GatewayARN *string // The password that you want to set for your SMB server. // // This member is required. Password *string }
SetSMBGuestPasswordInput
type SetSMBGuestPasswordOutput ¶
type SetSMBGuestPasswordOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ShutdownGatewayInput ¶
type ShutdownGatewayInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
type ShutdownGatewayOutput ¶
type ShutdownGatewayOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
type StartAvailabilityMonitorTestInput ¶
type StartAvailabilityMonitorTestInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type StartAvailabilityMonitorTestOutput ¶
type StartAvailabilityMonitorTestOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StartGatewayInput ¶
type StartGatewayInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
type StartGatewayOutput ¶
type StartGatewayOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
type UpdateAutomaticTapeCreationPolicyInput ¶
type UpdateAutomaticTapeCreationPolicyInput struct { // An automatic tape creation policy consists of a list of automatic tape creation // rules. The rules determine when and how to automatically create new tapes. // // This member is required. AutomaticTapeCreationRules []types.AutomaticTapeCreationRule // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type UpdateAutomaticTapeCreationPolicyOutput ¶
type UpdateAutomaticTapeCreationPolicyOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateBandwidthRateLimitInput ¶
type UpdateBandwidthRateLimitInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The average download bandwidth rate limit in bits per second. AverageDownloadRateLimitInBitsPerSec *int64 // The average upload bandwidth rate limit in bits per second. AverageUploadRateLimitInBitsPerSec *int64 }
A JSON object containing one or more of the following fields:
* UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
* UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
type UpdateBandwidthRateLimitOutput ¶
type UpdateBandwidthRateLimitOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
type UpdateBandwidthRateLimitScheduleInput ¶
type UpdateBandwidthRateLimitScheduleInput struct { // An array containing bandwidth rate limit schedule intervals for a gateway. When // no bandwidth rate limit intervals have been scheduled, the array is empty. // // This member is required. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
type UpdateBandwidthRateLimitScheduleOutput ¶
type UpdateBandwidthRateLimitScheduleOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateChapCredentialsInput ¶
type UpdateChapCredentialsInput struct { // The iSCSI initiator that connects to the target. // // This member is required. InitiatorName *string // The secret key that the initiator (for example, the Windows client) must provide // to participate in mutual CHAP with the target. The secret key must be between 12 // and 16 bytes when encoded in UTF-8. // // This member is required. SecretToAuthenticateInitiator *string // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the // DescribeStorediSCSIVolumes operation to return the TargetARN for specified // VolumeARN. // // This member is required. TargetARN *string // The secret key that the target must provide to participate in mutual CHAP with // the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. // Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded // in UTF-8. SecretToAuthenticateTarget *string }
A JSON object containing one or more of the following fields:
* UpdateChapCredentialsInput$InitiatorName
* UpdateChapCredentialsInput$SecretToAuthenticateInitiator
* UpdateChapCredentialsInput$SecretToAuthenticateTarget
* UpdateChapCredentialsInput$TargetARN
type UpdateChapCredentialsOutput ¶
type UpdateChapCredentialsOutput struct { // The iSCSI initiator that connects to the target. This is the same initiator name // specified in the request. InitiatorName *string // The Amazon Resource Name (ARN) of the target. This is the same target specified // in the request. TargetARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the following fields:
type UpdateGatewayInformationInput ¶
type UpdateGatewayInformationInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want // to use to monitor and log events in the gateway. For more information, see What // is Amazon CloudWatch Logs? // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) CloudWatchLogGroupARN *string // The name you configured for your gateway. GatewayName *string // A value that indicates the time zone of the gateway. GatewayTimezone *string }
type UpdateGatewayInformationOutput ¶
type UpdateGatewayInformationOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // The name you configured for your gateway. GatewayName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
type UpdateGatewaySoftwareNowInput ¶
type UpdateGatewaySoftwareNowInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string }
A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
type UpdateGatewaySoftwareNowOutput ¶
type UpdateGatewaySoftwareNowOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
type UpdateMaintenanceStartTimeInput ¶
type UpdateMaintenanceStartTimeInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // The hour component of the maintenance start time represented as hh, where hh is // the hour (00 to 23). The hour of the day is in the time zone of the gateway. // // This member is required. HourOfDay *int32 // The minute component of the maintenance start time represented as mm, where mm // is the minute (00 to 59). The minute of the hour is in the time zone of the // gateway. // // This member is required. MinuteOfHour *int32 // The day of the month component of the maintenance start time represented as an // ordinal number from 1 to 28, where 1 represents the first day of the month and // 28 represents the last day of the month. DayOfMonth *int32 // The day of the week component of the maintenance start time week represented as // an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. DayOfWeek *int32 }
A JSON object containing the following fields:
* UpdateMaintenanceStartTimeInput$DayOfMonth
* UpdateMaintenanceStartTimeInput$DayOfWeek
* UpdateMaintenanceStartTimeInput$HourOfDay
* UpdateMaintenanceStartTimeInput$MinuteOfHour
type UpdateMaintenanceStartTimeOutput ¶
type UpdateMaintenanceStartTimeOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
type UpdateNFSFileShareInput ¶
type UpdateNFSFileShareInput struct { // The Amazon Resource Name (ARN) of the file share to be updated. // // This member is required. *string // Refresh cache information. *types.CacheAttributes // The list of clients that are allowed to access the file gateway. The list must // contain either valid IP addresses or valid CIDR blocks. []string // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix // name is set in LocationARN. *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise // set to false. The default value is true. Valid Values: true | false *bool // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. *string // The default values for the file share. Optional. *types.NFSFileShareDefaults // The notification policy of the file share. *string // A value that sets the access control list (ACL) permission for objects in the S3 // bucket that a file gateway puts objects into. The default value is private. types.ObjectACL // A value that sets the write status of a file share. Set this value to true to // set the write status to read-only, otherwise set to false. Valid Values: true | // false *bool // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket // owner always pays the cost of storing data. RequesterPays is a configuration for // the S3 bucket that backs the file share, so make sure that the configuration on // the file share is the same as the S3 bucket configuration. Valid Values: true | // false *bool // The user mapped to anonymous user. Valid values are the following: // // * // RootSquash: Only root is mapped to anonymous user. // // * NoSquash: No one is mapped // to anonymous user. // // * AllSquash: Everyone is mapped to anonymous user. *string }
UpdateNFSFileShareInput
type UpdateNFSFileShareOutput ¶
type UpdateNFSFileShareOutput struct { // The Amazon Resource Name (ARN) of the updated file share. *string // Metadata pertaining to the operation's result. middleware.Metadata }
UpdateNFSFileShareOutput
type UpdateSMBFileShareInput ¶
type UpdateSMBFileShareInput struct { // The Amazon Resource Name (ARN) of the SMB file share that you want to update. // // This member is required. *string // The files and folders on this share will only be visible to users with read // access. *bool // A list of users or groups in the Active Directory that have administrator rights // to the file share. A group must be prefixed with the @ character. Acceptable // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be // set if Authentication is set to ActiveDirectory. []string // The Amazon Resource Name (ARN) of the storage used for the audit logs. *string // Refresh cache information. *types.CacheAttributes // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the // client determines the case sensitivity. For CaseSensitive, the gateway // determines the case sensitivity. The default value is ClientSpecified. types.CaseSensitivity // The default storage class for objects put into an Amazon S3 bucket by the file // gateway. The default value is S3_INTELLIGENT_TIERING. Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix // name is set in LocationARN. *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise // set to false. The default value is true. Valid Values: true | false *bool // A list of users or groups in the Active Directory that are not allowed to access // the file share. A group must be prefixed with the @ character. Acceptable // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be // set if Authentication is set to ActiveDirectory. []string // Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, // or false to use a key managed by Amazon S3. Optional. Valid Values: true | false *bool // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric // CMKs. This value can only be set when KMSEncrypted is true. Optional. *string // The notification policy of the file share. *string // A value that sets the access control list (ACL) permission for objects in the S3 // bucket that a file gateway puts objects into. The default value is private. types.ObjectACL // A value that sets the write status of a file share. Set this value to true to // set write status to read-only, otherwise set to false. Valid Values: true | // false *bool // A value that sets who pays the cost of the request and the cost associated with // data download from the S3 bucket. If this value is set to true, the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket // owner always pays the cost of storing data. RequesterPays is a configuration for // the S3 bucket that backs the file share, so make sure that the configuration on // the file share is the same as the S3 bucket configuration. Valid Values: true | // false *bool // Set this value to true to enable access control list (ACL) on the SMB file // share. Set it to false to map file and directory permissions to the POSIX // permissions. For more information, see Using Microsoft Windows ACLs to control // access to an SMB file share // (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in // the AWS Storage Gateway User Guide. Valid Values: true | false *bool // A list of users or groups in the Active Directory that are allowed to access the // file share. A group must be prefixed with the @ character. Acceptable formats // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if // Authentication is set to ActiveDirectory. []string }
UpdateSMBFileShareInput
type UpdateSMBFileShareOutput ¶
type UpdateSMBFileShareOutput struct { // The Amazon Resource Name (ARN) of the updated SMB file share. *string // Metadata pertaining to the operation's result. middleware.Metadata }
UpdateSMBFileShareOutput
type UpdateSMBFileShareVisibilityInput ¶
type UpdateSMBFileShareVisibilityInput struct { // The shares on this gateway appear when listing shares. // // This member is required. *bool // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. *string }
type UpdateSMBFileShareVisibilityOutput ¶
type UpdateSMBFileShareVisibilityOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. *string // Metadata pertaining to the operation's result. middleware.Metadata }
type UpdateSMBSecurityStrategyInput ¶
type UpdateSMBSecurityStrategyInput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. // // This member is required. GatewayARN *string // Specifies the type of security strategy. ClientSpecified: if you use this // option, requests are established based on what is negotiated by the client. This // option is recommended when you want to maximize compatibility across different // clients in your environment. MandatorySigning: if you use this option, file // gateway only allows connections from SMBv2 or SMBv3 clients that have signing // enabled. This option works with SMB clients on Microsoft Windows Vista, Windows // Server 2008 or newer. MandatoryEncryption: if you use this option, file gateway // only allows connections from SMBv3 clients that have encryption enabled. This // option is highly recommended for environments that handle sensitive data. This // option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or // newer. // // This member is required. SMBSecurityStrategy types.SMBSecurityStrategy }
type UpdateSMBSecurityStrategyOutput ¶
type UpdateSMBSecurityStrategyOutput struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to // return a list of gateways for your account and AWS Region. GatewayARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateSnapshotScheduleInput ¶
type UpdateSnapshotScheduleInput struct { // Frequency of snapshots. Specify the number of hours between snapshots. // // This member is required. RecurrenceInHours *int32 // The hour of the day at which the snapshot schedule begins represented as hh, // where hh is the hour (0 to 23). The hour of the day is in the time zone of the // gateway. // // This member is required. StartAt *int32 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes. // // This member is required. VolumeARN *string // Optional description of the snapshot that overwrites the existing description. Description *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a // key-value pair. Valid characters for key and value are letters, spaces, and // numbers representable in UTF-8 format, and the following special characters: + - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the // maximum length for a tag's value is 256. Tags []types.Tag }
A JSON object containing one or more of the following fields:
* UpdateSnapshotScheduleInput$Description
* UpdateSnapshotScheduleInput$RecurrenceInHours
* UpdateSnapshotScheduleInput$StartAt
* UpdateSnapshotScheduleInput$VolumeARN
type UpdateSnapshotScheduleOutput ¶
type UpdateSnapshotScheduleOutput struct { // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to // return a list of gateway volumes. VolumeARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
type UpdateVTLDeviceTypeInput ¶
type UpdateVTLDeviceTypeInput struct { // The type of medium changer you want to select. Valid Values: STK-L700 | // AWS-Gateway-VTL | IBM-03584L32-0402 // // This member is required. DeviceType *string // The Amazon Resource Name (ARN) of the medium changer you want to select. // // This member is required. VTLDeviceARN *string }
type UpdateVTLDeviceTypeOutput ¶
type UpdateVTLDeviceTypeOutput struct { // The Amazon Resource Name (ARN) of the medium changer you have selected. VTLDeviceARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
UpdateVTLDeviceTypeOutput
Source Files ¶
api_client.go api_op_ActivateGateway.go api_op_AddCache.go api_op_AddTagsToResource.go api_op_AddUploadBuffer.go api_op_AddWorkingStorage.go api_op_AssignTapePool.go api_op_AttachVolume.go api_op_CancelArchival.go api_op_CancelRetrieval.go api_op_CreateCachediSCSIVolume.go api_op_CreateNFSFileShare.go api_op_CreateSMBFileShare.go api_op_CreateSnapshot.go api_op_CreateSnapshotFromVolumeRecoveryPoint.go api_op_CreateStorediSCSIVolume.go api_op_CreateTapePool.go api_op_CreateTapeWithBarcode.go api_op_CreateTapes.go api_op_DeleteAutomaticTapeCreationPolicy.go api_op_DeleteBandwidthRateLimit.go api_op_DeleteChapCredentials.go api_op_DeleteFileShare.go api_op_DeleteGateway.go api_op_DeleteSnapshotSchedule.go api_op_DeleteTape.go api_op_DeleteTapeArchive.go api_op_DeleteTapePool.go api_op_DeleteVolume.go api_op_DescribeAvailabilityMonitorTest.go api_op_DescribeBandwidthRateLimit.go api_op_DescribeBandwidthRateLimitSchedule.go api_op_DescribeCache.go api_op_DescribeCachediSCSIVolumes.go api_op_DescribeChapCredentials.go api_op_DescribeGatewayInformation.go api_op_DescribeMaintenanceStartTime.go api_op_DescribeNFSFileShares.go api_op_DescribeSMBFileShares.go api_op_DescribeSMBSettings.go api_op_DescribeSnapshotSchedule.go api_op_DescribeStorediSCSIVolumes.go api_op_DescribeTapeArchives.go api_op_DescribeTapeRecoveryPoints.go api_op_DescribeTapes.go api_op_DescribeUploadBuffer.go api_op_DescribeVTLDevices.go api_op_DescribeWorkingStorage.go api_op_DetachVolume.go api_op_DisableGateway.go api_op_JoinDomain.go api_op_ListAutomaticTapeCreationPolicies.go api_op_ListFileShares.go api_op_ListGateways.go api_op_ListLocalDisks.go api_op_ListTagsForResource.go api_op_ListTapePools.go api_op_ListTapes.go api_op_ListVolumeInitiators.go api_op_ListVolumeRecoveryPoints.go api_op_ListVolumes.go api_op_NotifyWhenUploaded.go api_op_RefreshCache.go api_op_RemoveTagsFromResource.go api_op_ResetCache.go api_op_RetrieveTapeArchive.go api_op_RetrieveTapeRecoveryPoint.go api_op_SetLocalConsolePassword.go api_op_SetSMBGuestPassword.go api_op_ShutdownGateway.go api_op_StartAvailabilityMonitorTest.go api_op_StartGateway.go api_op_UpdateAutomaticTapeCreationPolicy.go api_op_UpdateBandwidthRateLimit.go api_op_UpdateBandwidthRateLimitSchedule.go api_op_UpdateChapCredentials.go api_op_UpdateGatewayInformation.go api_op_UpdateGatewaySoftwareNow.go api_op_UpdateMaintenanceStartTime.go api_op_UpdateNFSFileShare.go api_op_UpdateSMBFileShare.go api_op_UpdateSMBFileShareVisibility.go api_op_UpdateSMBSecurityStrategy.go api_op_UpdateSnapshotSchedule.go api_op_UpdateVTLDeviceType.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.0.0
- Published
- Jan 19, 2021
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.