12586 lines
777 KiB
JSON
12586 lines
777 KiB
JSON
{
|
|
"api_version": "2013-06-30",
|
|
"type": "json",
|
|
"json_version": 1.1,
|
|
"target_prefix": "StorageGateway_20130630",
|
|
"signature_version": "v4",
|
|
"service_full_name": "AWS Storage Gateway",
|
|
"endpoint_prefix": "storagegateway",
|
|
"xmlnamespace": "http://storagegateway.amazonaws.com/doc/2013-06-30",
|
|
"documentation": "\n <fullname>AWS Storage Gateway Service</fullname>\n\n <p>AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to\n provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage\n infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and\n rapid disaster recovery.</p>\n\n <p>Use the following links to get started using the <i>AWS Storage Gateway Service API Reference</i>:</p>\n <ul>\n <li>\n<a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayHTTPRequestsHeaders.html\">AWS Storage Gateway Required Request Headers</a>: Describes the required headers that you must send with\n every POST request to AWS Storage Gateway.</li>\n <li>\n<a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewaySigningRequests.html\">Signing Requests</a>: AWS Storage Gateway requires that you authenticate every request you send; this\n topic describes how sign such a request.</li>\n <li>\n<a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/APIErrorResponses.html\">Error\n Responses</a>: Provides reference information about AWS Storage Gateway errors.</li> \n <li>\n<a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPIOperations.html\">Operations in AWS Storage Gateway</a>: Contains detailed descriptions of all AWS Storage Gateway\n operations, their request parameters, response elements, possible errors, and examples of requests and\n responses.</li>\n <li>\n<a href=\"http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html\">AWS Storage Gateway Regions and\n Endpoints</a>: Provides a list of each of the regions and endpoints available for use with AWS Storage Gateway. </li>\n </ul>\n ",
|
|
"operations": {
|
|
"ActivateGateway": {
|
|
"name": "ActivateGateway",
|
|
"input": {
|
|
"shape_name": "ActivateGatewayInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"ActivationKey": {
|
|
"shape_name": "ActivationKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 50,
|
|
"documentation": "\n <p>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects\n enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key\n for your gateway in the query string parameter <code>activationKey</code>. It may also\n include other activation-related parameters, however, these are merely\n defaults -- the arguments you pass to the <code>ActivateGateway</code> API call\n determine the actual configuration of your gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"GatewayName": {
|
|
"shape_name": "GatewayName",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 255,
|
|
"pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$",
|
|
"documentation": "\n <p>A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which\n is what you use as an input to other operations.</p>\n ",
|
|
"required": true
|
|
},
|
|
"GatewayTimezone": {
|
|
"shape_name": "GatewayTimezone",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 10,
|
|
"documentation": "\n <p>One of the values that indicates the time zone you want to set for the gateway. The time\n zone is used, for example, for scheduling snapshots and your gateway's maintenance\n schedule.</p>\n ",
|
|
"required": true
|
|
},
|
|
"GatewayRegion": {
|
|
"shape_name": "RegionId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 25,
|
|
"documentation": "\n <p>One of the values that indicates the region where you want to store the snapshot\n backups. The gateway region specified must be the same region as the\n region in your <code>Host</code> header in the request. For more information about available regions \n and endpoints for AWS Storage Gateway, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">Regions and Endpoints</a> in\n the <b>Amazon Web Services Glossary</b>.</p>\n <p><i>Valid Values</i>: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"ap-northeast-1\", \"ap-southest-1\",\n \"sa-east-1\"</p>\n ",
|
|
"required": true
|
|
},
|
|
"GatewayType": {
|
|
"shape_name": "GatewayType",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 20,
|
|
"documentation": "\n <p>One of the values that defines the type of gateway to activate. The type specified is\n critical to all later functions of the gateway and cannot be changed after activation. The\n default value is <code>STORED</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>ActivateGatewayInput$ActivationKey</a>\n </li>\n <li>\n <a>GatewayName</a>\n </li>\n <li>\n <a>ActivateGatewayInput$GatewayRegion</a>\n </li>\n <li>\n <a>ActivateGatewayInput$GatewayTimezone</a>\n </li>\n <li>\n <a>ActivateGatewayInput$GatewayType</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ActivateGatewayOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of\n information such as your account, gateway name, and region. This ARN is\n used to reference the gateway in other API operations as well as\n resource-based authorization.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation activates the gateway you previously deployed on your host. For more\n information, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/DownloadAndDeploy.html\">Downloading \n and Deploying AWS Storage Gateway VM</a>. In the activation process you\n specify information such as the region you want to use for storing snapshots, the time zone\n for scheduled snapshots and the gateway schedule window, an activation key, and a name for\n your gateway. The activation process also associates your gateway with your account (see <a>UpdateGatewayInformation</a>).</p>\n <note>You must power on the gateway VM before you can activate your gateway.</note>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that activates a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ActivateGateway\n{\n \"ActivationKey\": \"29AV1-3OFV9-VVIUB-NKT0I-LRO6V\",\n \"GatewayName\": \"mygateway\",\n \"GatewayTimezone\": \"GMT-12:00\",\n \"GatewayRegion\": \"us-east-1\",\n \"GatewayType\": \"STORED\"\n}\n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"AddCache": {
|
|
"name": "AddCache",
|
|
"input": {
|
|
"shape_name": "AddCacheInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "AddCacheOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation configures one or more gateway local disks as cache for a cached-volume\n gateway. This operation is supported only for the gateway-cached volume architecture (see\n <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html\">Storage Gateway Concepts</a>).</p>\n <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and \n one or more disk IDs that you want to configure as cache.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that activates a gateway.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120425T120000Z\nx-amz-target: StorageGateway_20120630.AddCache\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [ \n \"pci-0000:03:00.0-scsi-0:0:0:0\", \n \"pci-0000:03:00.0-scsi-0:0:1:0\"\n ] \n}\n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 85\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"AddUploadBuffer": {
|
|
"name": "AddUploadBuffer",
|
|
"input": {
|
|
"shape_name": "AddUploadBufferInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "AddUploadBufferOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation configures one or more gateway local disks as upload buffer for a specified gateway. \n This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n </p>\n <p>\n In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer,\n and one or more disk IDs that you want to configure as upload buffer.</p> \n "
|
|
},
|
|
"AddWorkingStorage": {
|
|
"name": "AddWorkingStorage",
|
|
"input": {
|
|
"shape_name": "AddWorkingStorageInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>An array of strings that identify disks that are to be configured as working storage. Each string have a\n minimum length of 1 and maximum length of 300. You can get the disk IDs from\n the <a>ListLocalDisks</a> API.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>AddWorkingStorageInput$DiskIds</a>\n </li> \n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "AddWorkingStorageOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway for which working storage was configured.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation configures one or more gateway local disks as working storage for a gateway. \n This operation is supported only for the gateway-stored volume architecture.</p>\n <note><p>Working storage is also referred to as upload buffer. You can also use the \n <a>AddUploadBuffer</a> operation to add upload buffer to a stored-volume gateway.</p></note>\n <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage,\n and one or more disk IDs that you want to configure as working storage.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that specifies that two local disks of a gateway are to\n be configured as working storage.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.AddWorkingStorage\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:04:00.0-scsi-1:0:0:0\"]\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CancelArchival": {
|
|
"name": "CancelArchival",
|
|
"input": {
|
|
"shape_name": "CancelArchivalInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "CancelArchivalOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"CancelRetrieval": {
|
|
"name": "CancelRetrieval",
|
|
"input": {
|
|
"shape_name": "CancelRetrievalInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "CancelRetrievalOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"CreateCachediSCSIVolume": {
|
|
"name": "CreateCachediSCSIVolume",
|
|
"input": {
|
|
"shape_name": "CreateCachediSCSIVolumeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"VolumeSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"SnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": null
|
|
},
|
|
"TargetName": {
|
|
"shape_name": "TargetName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 200,
|
|
"pattern": "^[-\\.;a-z0-9]+$",
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"NetworkInterfaceId": {
|
|
"shape_name": "NetworkInterfaceId",
|
|
"type": "string",
|
|
"pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z",
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"ClientToken": {
|
|
"shape_name": "ClientToken",
|
|
"type": "string",
|
|
"min_length": 5,
|
|
"max_length": 100,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateCachediSCSIVolumeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation creates a cached volume on a specified cached gateway. This operation is\n supported only for the gateway-cached volume architecture.</p>\n <note>Cache storage must be allocated to the gateway before you can create a cached volume.\n Use the <a>AddCache</a> operation to add cache storage to a gateway. </note>\n <p>In the request, you must specify the gateway, size of the volume in bytes, the iSCSI\n target name, an IP address on which to expose the target, and a unique client token. In\n response, AWS Storage Gateway creates the volume and returns information about it such\n as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that\n initiators can use to connect to the volume target.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that specifies that a local disk of a gateway be\n configured as a cached volume.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateCachediSCSIVolume\n{\n \"ClientToken\": \"cachedvol112233\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"NetworkInterfaceId\": \"10.1.1.1\",\n \"TargetName\": \"myvolume\",\n \"VolumeSizeInBytes\": 536870912000\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 263\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreateSnapshot": {
|
|
"name": "CreateSnapshot",
|
|
"input": {
|
|
"shape_name": "CreateSnapshotInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SnapshotDescription": {
|
|
"shape_name": "SnapshotDescription",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot\n <b>Details</b> pane, <b>Description</b> field</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>CreateSnapshotInput$SnapshotDescription</a>\n </li>\n <li>\n <a>CreateSnapshotInput$VolumeARN</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateSnapshotOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.</p>\n "
|
|
},
|
|
"SnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": "\n <p>The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API <code>DescribeSnapshots</code>) or creating a volume from a snapshot\n (<a>CreateStorediSCSIVolume</a>).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation initiates a snapshot of a volume.</p>\n <p>AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple\n Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS)\n volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or\n ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href=\"TBD\">Working\n With Snapshots in the AWS Storage Gateway Console</a>.</p>\n <p>In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must\n also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the\n snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns\n you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to\n create a volume from a snapshot.</p>\n <note>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .</note>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example sends a <code>CreateSnapshot</code> request to take snapshot of the\n specified an example volume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateSnapshot\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 128\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotId\": \"snap-78e22663\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreateSnapshotFromVolumeRecoveryPoint": {
|
|
"name": "CreateSnapshotFromVolumeRecoveryPoint",
|
|
"input": {
|
|
"shape_name": "CreateSnapshotFromVolumeRecoveryPointInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"SnapshotDescription": {
|
|
"shape_name": "SnapshotDescription",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateSnapshotFromVolumeRecoveryPointOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"SnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": null
|
|
},
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"VolumeRecoveryPointTime": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).</p>\n <p>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 gateway-cached volumes, \n use <a>ListVolumeRecoveryPoints</a>.</p> \n <p>In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. <!--You provide this information in the request body.--> 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.</p>\n <note>\n <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>.</p>\n </note>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example sends a\n <code>CreateSnapshotFromVolumeRecoveryPoint</code> request to take snapshot of the\n specified an example volume.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateSnapshotFromVolumeRecoveryPoint\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"SnapshotId\": \"snap-78e22663\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-06-30T10:10:10.000Z\" \n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreateStorediSCSIVolume": {
|
|
"name": "CreateStorediSCSIVolume",
|
|
"input": {
|
|
"shape_name": "CreateStorediSCSIVolumeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"DiskId": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": "\n <p>The unique identifier for the gateway local disk that is configured as a stored volume. Use\n <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html\">ListLocalDisks</a> to list disk IDs for a gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": "\n <p>The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field\n if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list\n snapshots for your account use <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html\">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>\n "
|
|
},
|
|
"PreserveExistingData": {
|
|
"shape_name": "boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field\n as false creates an empty volume.</p>\n <p><i>Valid Values</i>: true, false</p>\n ",
|
|
"required": true
|
|
},
|
|
"TargetName": {
|
|
"shape_name": "TargetName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 200,
|
|
"pattern": "^[-\\.;a-z0-9]+$",
|
|
"documentation": "\n <p>The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.\n For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of\n arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The\n target name must be unique across all volumes of a gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"NetworkInterfaceId": {
|
|
"shape_name": "NetworkInterfaceId",
|
|
"type": "string",
|
|
"pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z",
|
|
"documentation": "\n <p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use\n <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</p>\n <p><i>Valid Values</i>: A valid IP address.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul> \n <li>\n <a>CreateStorediSCSIVolumeInput$DiskId</a>\n </li>\n <li>\n <a>CreateStorediSCSIVolumeInput$NetworkInterfaceId</a>\n </li>\n <li>\n <a>CreateStorediSCSIVolumeInput$PreserveExistingData</a>\n </li>\n <li>\n <a>CreateStorediSCSIVolumeInput$SnapshotId</a>\n </li>\n <li>\n <a>CreateStorediSCSIVolumeInput$TargetName</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateStorediSCSIVolumeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the configured volume.</p>\n "
|
|
},
|
|
"VolumeSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": "\n <p>The size of the volume in bytes.</p>\n "
|
|
},
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to\n connect to the target.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation creates a volume on a specified gateway. This operation is supported only for the gateway-cached volume architecture.\n </p>\n <p>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.</p>\n <p>In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage 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.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that specifies that a local disk of a gateway be\n configured as a volume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateStorediSCSIVolume\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"PreserveExistingData\": true,\n \"TargetName\": \"myvolume\",\n \"NetworkInterfaceId\": \"10.1.1.1\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 215\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreateTapes": {
|
|
"name": "CreateTapes",
|
|
"input": {
|
|
"shape_name": "CreateTapesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TapeSizeInBytes": {
|
|
"shape_name": "TapeSize",
|
|
"type": "long",
|
|
"min_length": 107374182400,
|
|
"max_length": 5497558138880,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"ClientToken": {
|
|
"shape_name": "ClientToken",
|
|
"type": "string",
|
|
"min_length": 5,
|
|
"max_length": 100,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"NumTapesToCreate": {
|
|
"shape_name": "NumTapesToCreate",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"max_length": 10,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"TapeBarcodePrefix": {
|
|
"shape_name": "TapeBarcodePrefix",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 4,
|
|
"pattern": "[A-Z0-9]*",
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateTapesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARNs": {
|
|
"shape_name": "TapeARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DeleteBandwidthRateLimit": {
|
|
"name": "DeleteBandwidthRateLimit",
|
|
"input": {
|
|
"shape_name": "DeleteBandwidthRateLimitInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"BandwidthType": {
|
|
"shape_name": "BandwidthType",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 25,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteBandwidthRateLimitOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway whose bandwidth rate information was deleted.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download\n bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains\n unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your\n request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that deletes both of the bandwidth rate limits of a\n gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"BandwidthType: \"All\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeleteChapCredentials": {
|
|
"name": "DeleteChapCredentials",
|
|
"input": {
|
|
"shape_name": "DeleteChapCredentialsInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</p>\n ",
|
|
"required": true
|
|
},
|
|
"InitiatorName": {
|
|
"shape_name": "IqnName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "[0-9a-z:.-]+",
|
|
"documentation": "\n <p>The iSCSI initiator that connects to the target.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>DeleteChapCredentialsInput$InitiatorName</a>\n </li>\n <li>\n <a>DeleteChapCredentialsInput$TargetARN</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteChapCredentialsOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the target.</p>\n "
|
|
},
|
|
"InitiatorName": {
|
|
"shape_name": "IqnName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "[0-9a-z:.-]+",
|
|
"documentation": "\n <p>The iSCSI initiator that connects to the target.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target and initiator pair.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that deletes the CHAP credentials for an iSCSI target\n myvolume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeleteGateway": {
|
|
"name": "DeleteGateway",
|
|
"input": {
|
|
"shape_name": "DeleteGatewayInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway to delete.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteGatewayOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the deleted gateway.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the\n gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual\n machine (VM) from your host computer.</p>\n <p>After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not\n deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway,\n your next step is to remove it from your environment.</p>\n <important>\n <p>You no longer pay software charges after the gateway is deleted; however, your existing\n Amazon EBS snapshots persist and you will continue to be billed for these\n snapshots.\u00a0You can choose to remove all remaining Amazon EBS snapshots by\n canceling your Amazon EC2 subscription.\u00a0 If you prefer not to cancel your Amazon\n EC2 subscription, you can delete your snapshots using the Amazon EC2 console.\n For more information, see the <a href=\"http://aws.amazon.com/storagegateway\">\n AWS Storage Gateway Detail Page</a>. </p>\n </important>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that deactivates a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeleteSnapshotSchedule": {
|
|
"name": "DeleteSnapshotSchedule",
|
|
"input": {
|
|
"shape_name": "DeleteSnapshotScheduleInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteSnapshotScheduleOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>\n This operation deletes a snapshot of a volume.\n </p>\n <p>\n You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API\n enables you to delete a snapshot schedule for a volume. For more information, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html\">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). \n </p>\n <note>\n <p>To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API\n Reference</i>.</p>\n </note> \n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example...</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DeleteSnapshotSchedule\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeleteTape": {
|
|
"name": "DeleteTape",
|
|
"input": {
|
|
"shape_name": "DeleteTapeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteTapeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DeleteTapeArchive": {
|
|
"name": "DeleteTapeArchive",
|
|
"input": {
|
|
"shape_name": "DeleteTapeArchiveInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteTapeArchiveOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DeleteVolume": {
|
|
"name": "DeleteVolume",
|
|
"input": {
|
|
"shape_name": "DeleteVolumeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the <a>DeleteVolumeInput$VolumeARN</a> to delete.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DeleteVolumeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the\n request.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the storage volume that was deleted</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation delete the specified gateway volume that you previously created using the\n <a>CreateStorediSCSIVolume</a> API. For gateway-stored volumes, the local disk that was configured as the storage\n volume is not deleted. You can reuse the local disk to create another storage volume. </p>\n <p>Before you delete a gateway volume, make sure there are no iSCSI connections to the volume\n you are deleting. You should also make sure there is no snapshot in progress. You can\n use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume\n you are deleting and check the snapshot status. For more information, go\n to <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html\">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>\n <p>In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that deletes a volume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteVolume\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeBandwidthRateLimit": {
|
|
"name": "DescribeBandwidthRateLimit",
|
|
"input": {
|
|
"shape_name": "DescribeBandwidthRateLimitInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeBandwidthRateLimitOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"AverageUploadRateLimitInBitsPerSec": {
|
|
"shape_name": "BandwidthUploadRateLimit",
|
|
"type": "long",
|
|
"min_length": 51200,
|
|
"documentation": "\n <p>The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the\n upload rate limit is not set.</p>\n "
|
|
},
|
|
"AverageDownloadRateLimitInBitsPerSec": {
|
|
"shape_name": "BandwidthDownloadRateLimit",
|
|
"type": "long",
|
|
"min_length": 102400,
|
|
"documentation": "\n <p>The average download bandwidth rate limit in bits per second. This field does not appear in the response if the\n download rate limit is not set.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n \n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which\n means no bandwidth rate limiting is in effect.</p>\n <p>This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set\n for the gateway, then this operation returns only the gateway ARN in the response body. To specify which\n gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns the bandwidth throttle properties of a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygate way\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 169\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 102400,\n \"AverageDownloadRateLimitInBitsPerSec\": 51200\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeCache": {
|
|
"name": "DescribeCache",
|
|
"input": {
|
|
"shape_name": "DescribeCacheInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeCacheOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"CacheAllocatedInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"CacheUsedPercentage": {
|
|
"shape_name": "double",
|
|
"type": "double",
|
|
"documentation": null
|
|
},
|
|
"CacheDirtyPercentage": {
|
|
"shape_name": "double",
|
|
"type": "double",
|
|
"documentation": null
|
|
},
|
|
"CacheHitPercentage": {
|
|
"shape_name": "double",
|
|
"type": "double",
|
|
"documentation": null
|
|
},
|
|
"CacheMissPercentage": {
|
|
"shape_name": "double",
|
|
"type": "double",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns information about the cache of a gateway. \n This operation is supported only for the gateway-cached volume architecture.\n </p>\n <p>\n The response includes disk IDs that are configured as cache, and it \n includes the amount of cache allocated and used. </p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request to obtain a description of a gateway's\n working storage.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCache\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"CacheAllocationInBytes\": 2199023255552,\n \"CacheDirtyPercentage\": 0.07,\n \"CacheHitPercentage\": 99.68,\n \"CacheMissPercentage\": 0.32,\n \"CacheUsedPercentage\": 0.07,\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeCachediSCSIVolumes": {
|
|
"name": "DescribeCachediSCSIVolumes",
|
|
"input": {
|
|
"shape_name": "DescribeCachediSCSIVolumesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARNs": {
|
|
"shape_name": "VolumeARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": null,
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeCachediSCSIVolumesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"CachediSCSIVolumes": {
|
|
"shape_name": "CachediSCSIVolumes",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CachediSCSIVolumeInformation",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"VolumeId": {
|
|
"shape_name": "VolumeId",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 30,
|
|
"documentation": null
|
|
},
|
|
"VolumeType": {
|
|
"shape_name": "VolumeType",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 100,
|
|
"documentation": null
|
|
},
|
|
"VolumeStatus": {
|
|
"shape_name": "VolumeStatus",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 50,
|
|
"documentation": null
|
|
},
|
|
"VolumeSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"VolumeProgress": {
|
|
"shape_name": "DoubleObject",
|
|
"type": "double",
|
|
"documentation": null
|
|
},
|
|
"SourceSnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": null
|
|
},
|
|
"VolumeiSCSIAttributes": {
|
|
"shape_name": "VolumeiSCSIAttributes",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume target.</p>\n "
|
|
},
|
|
"NetworkInterfaceId": {
|
|
"shape_name": "NetworkInterfaceId",
|
|
"type": "string",
|
|
"pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z",
|
|
"documentation": "\n <p>The network interface identifier.</p>\n "
|
|
},
|
|
"NetworkInterfacePort": {
|
|
"shape_name": "integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>The port used to communicate with iSCSI targets.</p>\n "
|
|
},
|
|
"LunNumber": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": "\n <p>The logical disk number.</p>\n "
|
|
},
|
|
"ChapEnabled": {
|
|
"shape_name": "boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>Indicates whether mutual CHAP is enabled for the iSCSI target.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Lists iSCSI information about a volume.</p>\n "
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>An array of objects where each object contains metadata about one cached volume.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n \n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns a description of the gateway volumes specified in the request. \n This operation is supported only for the gateway-cached volume architecture.</p>\n <p>\n The list of gateway volumes in the request must be from one gateway. \n In the response Amazon Storage Gateway returns volume information sorted by volume \n Amazon Resource Name (ARN). </p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns a description of a volume.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCachediSCSIVolumes\n\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 664\n\n{\n \"CachediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\": {\n \"ChapEnabled\": true,\n \"LunNumber\": 0,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"AVAILABLE\",\n \"VolumeType\": \"CACHED iSCSI\"\n }\n ]\n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeChapCredentials": {
|
|
"name": "DescribeChapCredentials",
|
|
"input": {
|
|
"shape_name": "DescribeChapCredentialsInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeChapCredentialsOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"ChapCredentials": {
|
|
"shape_name": "ChapCredentials",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ChapInfo",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume.</p>\n <p><i>Valid Values</i>: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>\n "
|
|
},
|
|
"SecretToAuthenticateInitiator": {
|
|
"shape_name": "ChapSecret",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 16,
|
|
"documentation": "\n <p>The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.</p>\n "
|
|
},
|
|
"InitiatorName": {
|
|
"shape_name": "IqnName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "[0-9a-z:.-]+",
|
|
"documentation": "\n <p>The iSCSI initiator that connects to the target.</p>\n "
|
|
},
|
|
"SecretToAuthenticateTarget": {
|
|
"shape_name": "ChapSecret",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 16,
|
|
"documentation": "\n <p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between\n your gateway and iSCSI initiators.</p>\n "
|
|
},
|
|
"documentation": "\n <p>An array of <a>ChapInfo</a> 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:</p>\n <ul>\n <li>\n <p><b>InitiatorName</b>: The iSCSI initiator that connects to the target.</p>\n\n </li>\n <li>\n <p><b>SecretToAuthenticateInitiator</b>: The secret key that the initiator (e.g. Windows client) must\n provide to participate in mutual CHAP with the target.</p>\n\n </li>\n <li>\n <p><b>SecretToAuthenticateTarget</b>: The secret key that the target must provide to participate in mutual\n CHAP with the initiator (e.g. Windows client).</p>\n\n </li>\n <li>\n <p><b>TargetARN</b>: The Amazon Resource Name (ARN) of the storage volume.</p>\n\n </li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing a .</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information\n for a specified iSCSI target, one for each target-initiator pair.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns the CHAP credentials of an iSCSI\n target.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 235\n{\n \"ChapCredentials\": {\n \"TargetName\": \"iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeGatewayInformation": {
|
|
"name": "DescribeGatewayInformation",
|
|
"input": {
|
|
"shape_name": "DescribeGatewayInformationInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeGatewayInformationOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"GatewayId": {
|
|
"shape_name": "GatewayId",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 30,
|
|
"documentation": "\n <p>The gateway ID.</p>\n "
|
|
},
|
|
"GatewayTimezone": {
|
|
"shape_name": "GatewayTimezone",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 10,
|
|
"documentation": "\n <p>One of the values that indicates the time zone configured for the gateway.</p>\n "
|
|
},
|
|
"GatewayState": {
|
|
"shape_name": "GatewayState",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 25,
|
|
"documentation": "\n <p>One of the values that indicates the operating state of the gateway.</p>\n "
|
|
},
|
|
"GatewayNetworkInterfaces": {
|
|
"shape_name": "GatewayNetworkInterfaces",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "NetworkInterface",
|
|
"type": "structure",
|
|
"members": {
|
|
"Ipv4Address": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Internet Protocol version 4 (IPv4) address of the interface.</p>\n "
|
|
},
|
|
"MacAddress": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Media Access Control (MAC) address of the interface.</p>\n <note>This is currently unsupported and will not be returned in output.</note>\n "
|
|
},
|
|
"Ipv6Address": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Internet Protocol version 6 (IPv6) address of the interface. <i>Currently not supported</i>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Describes a gateway's network interface.</p>\n "
|
|
},
|
|
"documentation": "\n <p>A <a>NetworkInterface</a> array that contains descriptions of the gateway network interfaces.</p>\n "
|
|
},
|
|
"GatewayType": {
|
|
"shape_name": "GatewayType",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 20,
|
|
"documentation": "\n <p>TBD</p>\n "
|
|
},
|
|
"NextUpdateAvailabilityDate": {
|
|
"shape_name": "NextUpdateAvailabilityDate",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 25,
|
|
"documentation": "\n <p>The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the\n gateway is not available for an update this field is not returned in the response.</p>\n <!-- Q: [eronh] This next sentence doesn't seem to agree with the preceding one, nor does it agree with the\n response example. -->\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and\n the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon\n Resource Name (ARN) of the gateway in your request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request for describing a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 227\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayId\": \"sgw-AABB1122\",\n \"GatewayNetworkInterfaces\": [ {\"Ipv4Address\": \"10.35.69.216\"} ],\n \"GatewayState\": \"STATE_RUNNING\",\n \"GatewayTimezone\": \"GMT-8:00\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeMaintenanceStartTime": {
|
|
"name": "DescribeMaintenanceStartTime",
|
|
"input": {
|
|
"shape_name": "DescribeMaintenanceStartTimeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeMaintenanceStartTimeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"HourOfDay": {
|
|
"shape_name": "HourOfDay",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 23,
|
|
"documentation": null
|
|
},
|
|
"MinuteOfHour": {
|
|
"shape_name": "MinuteOfHour",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 59,
|
|
"documentation": null
|
|
},
|
|
"DayOfWeek": {
|
|
"shape_name": "DayOfWeek",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 6,
|
|
"documentation": null
|
|
},
|
|
"Timezone": {
|
|
"shape_name": "GatewayTimezone",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 10,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns your gateway's weekly maintenance start time including the day and time of the week.\n Note that values are in terms of the gateway's time zone.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that describes a gateway's maintenance\n window.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 136\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 15,\n \"MinuteOfHour\": 35,\n \"DayOfWeek\": 2,\n \"Timezone\": \"GMT+7:00\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeSnapshotSchedule": {
|
|
"name": "DescribeSnapshotSchedule",
|
|
"input": {
|
|
"shape_name": "DescribeSnapshotScheduleInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway\n volumes.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the <a>DescribeSnapshotScheduleInput$VolumeARN</a> of the volume.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeSnapshotScheduleOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"StartAt": {
|
|
"shape_name": "HourOfDay",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 23,
|
|
"documentation": null
|
|
},
|
|
"RecurrenceInHours": {
|
|
"shape_name": "RecurrenceInHours",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"max_length": 24,
|
|
"documentation": null
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"Timezone": {
|
|
"shape_name": "GatewayTimezone",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 10,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule\n information includes intervals at which snapshots are automatically initiated on the volume.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that retrieves the snapshot schedule for a\n volume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 211\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 6,\n \"RecurrenceInHours\": 24,\n \"Description\": \"sgw-AABB1122:vol-AABB1122:Schedule\",\n \"Timezone\": \"GMT+7:00\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeStorediSCSIVolumes": {
|
|
"name": "DescribeStorediSCSIVolumes",
|
|
"input": {
|
|
"shape_name": "DescribeStorediSCSIVolumesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARNs": {
|
|
"shape_name": "VolumeARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the\n specified stored volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a\n gateway.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON Object containing a list of <a>DescribeStorediSCSIVolumesInput$VolumeARNs</a>.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeStorediSCSIVolumesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"StorediSCSIVolumes": {
|
|
"shape_name": "StorediSCSIVolumes",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "StorediSCSIVolumeInformation",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"VolumeId": {
|
|
"shape_name": "VolumeId",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 30,
|
|
"documentation": null
|
|
},
|
|
"VolumeType": {
|
|
"shape_name": "VolumeType",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 100,
|
|
"documentation": null
|
|
},
|
|
"VolumeStatus": {
|
|
"shape_name": "VolumeStatus",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 50,
|
|
"documentation": null
|
|
},
|
|
"VolumeSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"VolumeProgress": {
|
|
"shape_name": "DoubleObject",
|
|
"type": "double",
|
|
"documentation": null
|
|
},
|
|
"VolumeDiskId": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"SourceSnapshotId": {
|
|
"shape_name": "SnapshotId",
|
|
"type": "string",
|
|
"pattern": "\\Asnap-[0-9a-fA-F]{8}\\z",
|
|
"documentation": null
|
|
},
|
|
"PreservedExistingData": {
|
|
"shape_name": "boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
},
|
|
"VolumeiSCSIAttributes": {
|
|
"shape_name": "VolumeiSCSIAttributes",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume target.</p>\n "
|
|
},
|
|
"NetworkInterfaceId": {
|
|
"shape_name": "NetworkInterfaceId",
|
|
"type": "string",
|
|
"pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z",
|
|
"documentation": "\n <p>The network interface identifier.</p>\n "
|
|
},
|
|
"NetworkInterfacePort": {
|
|
"shape_name": "integer",
|
|
"type": "integer",
|
|
"documentation": "\n <p>The port used to communicate with iSCSI targets.</p>\n "
|
|
},
|
|
"LunNumber": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": "\n <p>The logical disk number.</p>\n "
|
|
},
|
|
"ChapEnabled": {
|
|
"shape_name": "boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n <p>Indicates whether mutual CHAP is enabled for the iSCSI target.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Lists iSCSI information about a volume.</p>\n "
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns description of the gateway volumes specified in the request. The list of gateway volumes\n in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information\n sorted by volume ARNs.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns a description of a volume.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeStorediSCSIVolumes\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 507\n{\n \"StorediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\":\n {\n \"ChapEnabled\": true,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"PreservedExistingData\": false,\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/myg\n ateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeProgress\": 23.7,\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"BOOTSTRAPPING\"\n }\n ]\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeTapeArchives": {
|
|
"name": "DescribeTapeArchives",
|
|
"input": {
|
|
"shape_name": "DescribeTapeArchivesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARNs": {
|
|
"shape_name": "TapeARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeTapeArchivesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeArchives": {
|
|
"shape_name": "TapeArchives",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "TapeArchive",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"TapeBarcode": {
|
|
"shape_name": "TapeBarcode",
|
|
"type": "string",
|
|
"min_length": 8,
|
|
"max_length": 16,
|
|
"pattern": "[A-Z0-9]*",
|
|
"documentation": null
|
|
},
|
|
"TapeSizeInBytes": {
|
|
"shape_name": "TapeSize",
|
|
"type": "long",
|
|
"min_length": 107374182400,
|
|
"max_length": 5497558138880,
|
|
"documentation": null
|
|
},
|
|
"CompletionTime": {
|
|
"shape_name": "Time",
|
|
"type": "timestamp",
|
|
"documentation": null
|
|
},
|
|
"RetrievedTo": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"TapeStatus": {
|
|
"shape_name": "TapeArchiveStatus",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DescribeTapeRecoveryPoints": {
|
|
"name": "DescribeTapeRecoveryPoints",
|
|
"input": {
|
|
"shape_name": "DescribeTapeRecoveryPointsInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeTapeRecoveryPointsOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"TapeRecoveryPointInfos": {
|
|
"shape_name": "TapeRecoveryPointInfos",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "TapeRecoveryPointInfo",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"TapeRecoveryPointTime": {
|
|
"shape_name": "Time",
|
|
"type": "timestamp",
|
|
"documentation": null
|
|
},
|
|
"TapeSizeInBytes": {
|
|
"shape_name": "TapeSize",
|
|
"type": "long",
|
|
"min_length": 107374182400,
|
|
"max_length": 5497558138880,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DescribeTapes": {
|
|
"name": "DescribeTapes",
|
|
"input": {
|
|
"shape_name": "DescribeTapesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"TapeARNs": {
|
|
"shape_name": "TapeARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeTapesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Tapes": {
|
|
"shape_name": "Tapes",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Tape",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"TapeBarcode": {
|
|
"shape_name": "TapeBarcode",
|
|
"type": "string",
|
|
"min_length": 8,
|
|
"max_length": 16,
|
|
"pattern": "[A-Z0-9]*",
|
|
"documentation": null
|
|
},
|
|
"TapeSizeInBytes": {
|
|
"shape_name": "TapeSize",
|
|
"type": "long",
|
|
"min_length": 107374182400,
|
|
"max_length": 5497558138880,
|
|
"documentation": null
|
|
},
|
|
"TapeStatus": {
|
|
"shape_name": "TapeStatus",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"VTLDevice": {
|
|
"shape_name": "VTLDeviceARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"Progress": {
|
|
"shape_name": "DoubleObject",
|
|
"type": "double",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DescribeUploadBuffer": {
|
|
"name": "DescribeUploadBuffer",
|
|
"input": {
|
|
"shape_name": "DescribeUploadBufferInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeUploadBufferOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"UploadBufferUsedInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"UploadBufferAllocatedInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n </p>\n <p>\n The response includes disk IDs that are configured as upload buffer space, and it includes\n the amount of upload buffer space allocated and used.</p> \n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request to obtain a description of a gateway's\n working storage.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeUploadBuffer\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"UploadBufferAllocatedInBytes\": 161061273600,\n \"UploadBufferUsedInBytes\": 0\n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DescribeVTLDevices": {
|
|
"name": "DescribeVTLDevices",
|
|
"input": {
|
|
"shape_name": "DescribeVTLDevicesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"VTLDeviceARNs": {
|
|
"shape_name": "VTLDeviceARNs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VTLDeviceARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeVTLDevicesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"VTLDevices": {
|
|
"shape_name": "VTLDevices",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VTLDevice",
|
|
"type": "structure",
|
|
"members": {
|
|
"VTLDeviceARN": {
|
|
"shape_name": "VTLDeviceARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"DeviceiSCSIAttributes": {
|
|
"shape_name": "DeviceiSCSIAttributes",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": null
|
|
},
|
|
"NetworkInterfaceId": {
|
|
"shape_name": "NetworkInterfaceId",
|
|
"type": "string",
|
|
"pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z",
|
|
"documentation": null
|
|
},
|
|
"NetworkInterfacePort": {
|
|
"shape_name": "integer",
|
|
"type": "integer",
|
|
"documentation": null
|
|
},
|
|
"ChapEnabled": {
|
|
"shape_name": "boolean",
|
|
"type": "boolean",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"DescribeWorkingStorage": {
|
|
"name": "DescribeWorkingStorage",
|
|
"input": {
|
|
"shape_name": "DescribeWorkingStorageInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DescribeWorkingStorageOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"DiskIds": {
|
|
"shape_name": "DiskIds",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is\n specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as\n working storage, then the DiskIds array is empty.</p>\n "
|
|
},
|
|
"WorkingStorageUsedInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": "\n <p>The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway,\n this field returns 0.</p>\n "
|
|
},
|
|
"WorkingStorageAllocatedInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": "\n <p>The total working storage in bytes allocated for the gateway. If no working storage is configured for the\n gateway, this field returns 0.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n \n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. </p>\n <note><p>Working storage is also referred to as upload buffer. You can also use the <a>DescribeUploadBuffer</a> operation to add upload buffer to a stored-volume gateway.</p></note>\n <p>The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request to obtain a description of a gateway's working\n storage.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeWorkingStorage\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 241\n{\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:03:00.0-scsi-0:0:1:0\"],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"WorkingStorageAllocatedInBytes\": 2199023255552,\n \"WorkingStorageUsedInBytes\": 789207040\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DisableGateway": {
|
|
"name": "DisableGateway",
|
|
"input": {
|
|
"shape_name": "DisableGatewayInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "DisableGatewayOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"ListGateways": {
|
|
"name": "ListGateways",
|
|
"input": {
|
|
"shape_name": "ListGatewaysInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": "\n <p>An opaque string that indicates the position at which to begin the returned list of gateways.</p>\n "
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": "\n <p>Specifies that the list of gateways returned be limited to the specified number of items.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing zero or more of the following fields:</p>\n <ul>\n <li>\n <a>ListGatewaysInput$Limit</a>\n </li>\n <li>\n <a>ListGatewaysInput$Marker</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListGatewaysOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Gateways": {
|
|
"shape_name": "Gateways",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "GatewayInformation",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"GatewayType": {
|
|
"shape_name": "GatewayType",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 20,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation lists gateways owned by an AWS account in a region specified in the request. The returned list\n is ordered by gateway Amazon Resource Name (ARN).</p>\n <p>By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you\n to optionally reduce the number of gateways returned in a response.</p>\n <p>If you have more gateways than are returned in a response-that is, the response returns only a truncated list\n of your gateways-the response contains a marker that you can specify in your next request to fetch the next\n page of gateways.</p>\n <examples>\n <example>\n <name>List Gateways</name>\n <description>The following example does not specify any criteria for the returned list. Note that the\n request body is \"{}\". The response returns gateways (or up to the first 100) in the\n specified region owned by the AWS account.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListGateways\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 178\n{\n \"GatewayList\": [\n {\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n }\n ]\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"ListLocalDisks": {
|
|
"name": "ListLocalDisks",
|
|
"input": {
|
|
"shape_name": "ListLocalDisksInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListLocalDisksOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"Disks": {
|
|
"shape_name": "Disks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DiskInformation",
|
|
"type": "structure",
|
|
"members": {
|
|
"DiskId": {
|
|
"shape_name": "DiskId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 300,
|
|
"documentation": null
|
|
},
|
|
"DiskPath": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"DiskNode": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"DiskSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"DiskAllocationType": {
|
|
"shape_name": "DiskAllocationType",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 100,
|
|
"documentation": null
|
|
},
|
|
"DiskAllocationResource": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation returns a list of the local disks of a gateway. To specify which gateway to describe you use the\n Amazon Resource Name (ARN) of the gateway in the body of the request.</p>\n <p>The request returns all disks, specifying which are configured as working storage, stored volume or not\n configured at all.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns information about a gateway's local\n disks.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListLocalDisks\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 398\n{\n \"Disks\": [\n {\n \"DiskAllocationType\": \"UPLOAD_BUFFER\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"DiskNode\": \"SCSI(0:0)\",\n \"DiskPath\": \"/dev/sda\",\n \"DiskSizeInBytes\": 1099511627776\n },\n {\n \"DiskAllocationType\": \"STORED_iSCSI_VOLUME\",\n \"DiskAllocationResource\": \"\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:1:0\",\n \"DiskNode\": \"SCSI(0:1)\",\n \"DiskPath\": \"/dev/sdb\",\n \"DiskSizeInBytes\": 1099511627776\n }\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"ListVolumeRecoveryPoints": {
|
|
"name": "ListVolumeRecoveryPoints",
|
|
"input": {
|
|
"shape_name": "ListVolumeRecoveryPointsInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "ListVolumeRecoveryPointsOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"VolumeRecoveryPointInfos": {
|
|
"shape_name": "VolumeRecoveryPointInfos",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VolumeRecoveryPointInfo",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"VolumeSizeInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"VolumeUsageInBytes": {
|
|
"shape_name": "long",
|
|
"type": "long",
|
|
"documentation": null
|
|
},
|
|
"VolumeRecoveryPointTime": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.</p>\n <p>Each gateway-cached volume has one recovery point. A volume recovery point is a point \n in time at which all data of the volume is consistent and from which you can create a snapshot. \n To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example sends a <code>ListVolumeRecoveryPoints</code> request to take a\n snapshot of the specified example volume.</description>\n <request>\nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.ListVolumeRecoveryPoints\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeRecoveryPointInfos\": [ \n { \n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-09-04T21:08:44.627Z\",\n \"VolumeSizeInBytes\": 536870912000,\n \"VolumeUsageInBytes\": 6694048\n } \n ] \n} \n\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"ListVolumes": {
|
|
"name": "ListVolumes",
|
|
"input": {
|
|
"shape_name": "ListVolumesInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": "\n <p>A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the\n response of a previous List iSCSI Volumes request.</p>\n "
|
|
},
|
|
"Limit": {
|
|
"shape_name": "PositiveIntObject",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"documentation": "\n <p>Specifies that the list of volumes returned be limited to the specified number of items.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object that contains one or more of the following fields:</p>\n <ul>\n <li>\n <a>ListVolumesInput$Limit</a>\n </li>\n <li>\n <a>ListVolumesInput$Marker</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListVolumesOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
},
|
|
"Marker": {
|
|
"shape_name": "Marker",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 1000,
|
|
"documentation": null
|
|
},
|
|
"VolumeInfos": {
|
|
"shape_name": "VolumeInfos",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "VolumeInformation",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
},
|
|
"VolumeType": {
|
|
"shape_name": "VolumeType",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 100,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response\n includes only the volume ARNs. If you want additional volume information, use the\n <a>DescribeStorediSCSIVolumes</a> API.</p>\n <p>The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can\n optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If\n the number of volumes returned in the response is truncated, the response includes a Marker field. You can use\n this Marker value in your subsequent request to retrieve the next set of volumes.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The List iSCSI Volumes request in this example does not specify a <code>limit</code> or\n <code>marker</code> field in the response body. The response returns the volumes\n (up to the first 100) of the gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListVolumes\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 346\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeInfos\": [\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeType\": \"STORED\"\n },\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-3344CCDD\",\n \"VolumeType\": \"STORED\"\n },\n ]\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"RetrieveTapeArchive": {
|
|
"name": "RetrieveTapeArchive",
|
|
"input": {
|
|
"shape_name": "RetrieveTapeArchiveInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "RetrieveTapeArchiveOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"RetrieveTapeRecoveryPoint": {
|
|
"name": "RetrieveTapeRecoveryPoint",
|
|
"input": {
|
|
"shape_name": "RetrieveTapeRecoveryPointInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null,
|
|
"required": true
|
|
},
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "RetrieveTapeRecoveryPointOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TapeARN": {
|
|
"shape_name": "TapeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": null
|
|
},
|
|
"ShutdownGateway": {
|
|
"name": "ShutdownGateway",
|
|
"input": {
|
|
"shape_name": "ShutdownGatewayInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway to shut down.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ShutdownGatewayOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway that was shut down.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN)\n of the gateway in the body of your request.</p>\n <p>The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM)\n and not the VM.</p>\n <note>If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM\n to avoid unpredictable conditions.</note>\n <p>After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>,\n <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see\n <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there\n are no snapshots taken.</p>\n <note>When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However,\n it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to\n check the status. For more information, see <a>ActivateGateway</a>.</note>\n <p>If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay\n software charges associated with the gateway.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that shuts down a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ShutdownGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"StartGateway": {
|
|
"name": "StartGateway",
|
|
"input": {
|
|
"shape_name": "StartGatewayInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway to start.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "StartGatewayOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway that was restarted.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway\n starts, you can then make other API calls, your applications can read from or write to the gateway's storage\n volumes and you will be able to take snapshot backups.</p>\n <note>When you make a request, you will get a 200 OK success response immediately. However, it might take some\n time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before\n making any additional API calls. For more information, see <a>ActivateGateway</a>.</note>\n <p>To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that starts a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.StartGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateBandwidthRateLimit": {
|
|
"name": "UpdateBandwidthRateLimit",
|
|
"input": {
|
|
"shape_name": "UpdateBandwidthRateLimitInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"AverageUploadRateLimitInBitsPerSec": {
|
|
"shape_name": "BandwidthUploadRateLimit",
|
|
"type": "long",
|
|
"min_length": 51200,
|
|
"documentation": "\n <p>The average upload bandwidth rate limit in bits per second.</p>\n "
|
|
},
|
|
"AverageDownloadRateLimitInBitsPerSec": {
|
|
"shape_name": "BandwidthDownloadRateLimit",
|
|
"type": "long",
|
|
"min_length": 102400,
|
|
"documentation": "\n <p>The average download bandwidth rate limit in bits per second.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec</a>\n </li>\n <li>\n <a>UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateBandwidthRateLimitOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway whose throttle information was updated.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download\n bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate\n limit remains.</p>\n <p>By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not\n have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.</p>\n <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that returns the bandwidth throttle properties of a\n gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 51200,\n \"AverageDownloadRateLimitInBitsPerSec\": 102400\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateChapCredentials": {
|
|
"name": "UpdateChapCredentials",
|
|
"input": {
|
|
"shape_name": "UpdateChapCredentialsInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation\n to return to retrieve the TargetARN for specified VolumeARN.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SecretToAuthenticateInitiator": {
|
|
"shape_name": "ChapSecret",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 16,
|
|
"documentation": "\n <p>The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the\n target.</p>\n ",
|
|
"required": true
|
|
},
|
|
"InitiatorName": {
|
|
"shape_name": "IqnName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "[0-9a-z:.-]+",
|
|
"documentation": "\n <p>The iSCSI initiator that connects to the target.</p>\n ",
|
|
"required": true
|
|
},
|
|
"SecretToAuthenticateTarget": {
|
|
"shape_name": "ChapSecret",
|
|
"type": "string",
|
|
"min_length": 12,
|
|
"max_length": 16,
|
|
"documentation": "\n <p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>UpdateChapCredentialsInput$InitiatorName</a>\n </li>\n <li>\n <a>UpdateChapCredentialsInput$SecretToAuthenticateInitiator</a>\n </li>\n <li>\n <a>UpdateChapCredentialsInput$SecretToAuthenticateTarget</a>\n </li>\n <li>\n <a>UpdateChapCredentialsInput$TargetARN</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateChapCredentialsOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"TargetARN": {
|
|
"shape_name": "TargetARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 800,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.</p>\n "
|
|
},
|
|
"InitiatorName": {
|
|
"shape_name": "IqnName",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "[0-9a-z:.-]+",
|
|
"documentation": "\n <p>The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n \n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.</p>\n <important>\n <p>When you update CHAP credentials, all existing connections on the target are\n closed and initiators must reconnect with the new credentials.</p>\n </important>\n \n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that updates CHAP credentials for an iSCSI\n target.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateGatewayInformation": {
|
|
"name": "UpdateGatewayInformation",
|
|
"input": {
|
|
"shape_name": "UpdateGatewayInformationInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"GatewayName": {
|
|
"shape_name": "GatewayName",
|
|
"type": "string",
|
|
"min_length": 2,
|
|
"max_length": 255,
|
|
"pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$",
|
|
"documentation": "\n <p>A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which\n is what you use as an input to other operations.</p>\n "
|
|
},
|
|
"GatewayTimezone": {
|
|
"shape_name": "GatewayTimezone",
|
|
"type": "string",
|
|
"min_length": 3,
|
|
"max_length": 10,
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateGatewayInformationOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway that was updated.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which\n gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that updates the name of a gateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayName\" \"mygateway2\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 81\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateGatewaySoftwareNow": {
|
|
"name": "UpdateGatewaySoftwareNow",
|
|
"input": {
|
|
"shape_name": "UpdateGatewaySoftwareNowInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway to update.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateGatewaySoftwareNowOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway that was updated.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software\n update. <!--Before initiating this update, make sure there is no traffic to the gateway.</p>\n <p>Before sending this request, you should make sure all your applications have finished writing to your gateway's\n storage volumes in order to avoid data loss. During the update, applications cannot use the gateway's storage\n volumes. --></p>\n <note>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might\n take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway\n is in the <code>STATE_RUNNING</code> state.</note>\n <important>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to\n your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI\n Initiator timeouts for Windows and Linux, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings\">Customizing Your Windows iSCSI Settings</a> and <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings\">Customizing Your Linux iSCSI Settings</a>, respectively.</important>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that initiates a gateway VM update.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewaySoftwareNow\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateMaintenanceStartTime": {
|
|
"name": "UpdateMaintenanceStartTime",
|
|
"input": {
|
|
"shape_name": "UpdateMaintenanceStartTimeInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
},
|
|
"HourOfDay": {
|
|
"shape_name": "HourOfDay",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 23,
|
|
"documentation": "\n <p>The hour component of the maintenance start time represented as <emphasis>hh</emphasis>,\n where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time zone of the gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"MinuteOfHour": {
|
|
"shape_name": "MinuteOfHour",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 59,
|
|
"documentation": "\n <p>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute\n (00 to 59). The minute of the hour is in the time zone of the gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"DayOfWeek": {
|
|
"shape_name": "DayOfWeek",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 6,
|
|
"documentation": "\n <p>The maintenance start time day of the week.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the following fields:</p>\n <ul>\n <li>\n <a>UpdateMaintenanceStartTimeInput$DayOfWeek</a>\n </li>\n <li>\n <a>UpdateMaintenanceStartTimeInput$HourOfDay</a>\n </li>\n <li>\n <a>UpdateMaintenanceStartTimeInput$MinuteOfHour</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateMaintenanceStartTimeOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"GatewayARN": {
|
|
"shape_name": "GatewayARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of\n gateways for your account and region.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the gateway whose maintenance start time is updated.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates a gateway's weekly maintenance start time information, including day and time of the\n week. The maintenance time is the time in your gateway's time zone.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that updates the maintenance start time of\n mygateway.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 0,\n \"MinuteOfHour\": 30,\n \"DayOfWeek\": 2\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} </response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdateSnapshotSchedule": {
|
|
"name": "UpdateSnapshotSchedule",
|
|
"input": {
|
|
"shape_name": "UpdateSnapshotScheduleInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway\n volumes.</p>\n ",
|
|
"required": true
|
|
},
|
|
"StartAt": {
|
|
"shape_name": "HourOfDay",
|
|
"type": "integer",
|
|
"min_length": 0,
|
|
"max_length": 23,
|
|
"documentation": "\n <p>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour\n (0 to 23). The hour of the day is in the time zone of the gateway.</p>\n ",
|
|
"required": true
|
|
},
|
|
"RecurrenceInHours": {
|
|
"shape_name": "RecurrenceInHours",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"max_length": 24,
|
|
"documentation": "\n <p>Frequency of snapshots. Specify the number of hours between snapshots.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Optional description of the snapshot that overwrites the existing description.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing one or more of the following fields:</p>\n <ul>\n <li>\n <a>UpdateSnapshotScheduleInput$Description</a>\n </li>\n <li>\n <a>UpdateSnapshotScheduleInput$RecurrenceInHours</a>\n </li>\n <li>\n <a>UpdateSnapshotScheduleInput$StartAt</a>\n </li>\n <li>\n <a>UpdateSnapshotScheduleInput$VolumeARN</a>\n </li>\n </ul>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateSnapshotScheduleOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"VolumeARN": {
|
|
"shape_name": "VolumeARN",
|
|
"type": "string",
|
|
"min_length": 50,
|
|
"max_length": 500,
|
|
"documentation": "\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A JSON object containing the of the updated storage volume.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidGatewayRequestException",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServerError",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": "\n <p>A human-readable message describing the error that occured.</p>\n "
|
|
},
|
|
"error": {
|
|
"shape_name": "StorageGatewayError",
|
|
"type": "structure",
|
|
"members": {
|
|
"errorCode": {
|
|
"shape_name": "ErrorCode",
|
|
"type": "string",
|
|
"enum": [
|
|
"ActivationKeyExpired",
|
|
"ActivationKeyInvalid",
|
|
"ActivationKeyNotFound",
|
|
"GatewayInternalError",
|
|
"GatewayNotConnected",
|
|
"GatewayNotFound",
|
|
"GatewayProxyNetworkConnectionBusy",
|
|
"AuthenticationFailure",
|
|
"BandwidthThrottleScheduleNotFound",
|
|
"Blocked",
|
|
"CannotExportSnapshot",
|
|
"ChapCredentialNotFound",
|
|
"DiskAlreadyAllocated",
|
|
"DiskDoesNotExist",
|
|
"DiskSizeGreaterThanVolumeMaxSize",
|
|
"DiskSizeLessThanVolumeSize",
|
|
"DiskSizeNotGigAligned",
|
|
"DuplicateCertificateInfo",
|
|
"DuplicateSchedule",
|
|
"EndpointNotFound",
|
|
"IAMNotSupported",
|
|
"InitiatorInvalid",
|
|
"InitiatorNotFound",
|
|
"InternalError",
|
|
"InvalidGateway",
|
|
"InvalidEndpoint",
|
|
"InvalidParameters",
|
|
"InvalidSchedule",
|
|
"LocalStorageLimitExceeded",
|
|
"LunAlreadyAllocated ",
|
|
"LunInvalid",
|
|
"MaximumContentLengthExceeded",
|
|
"MaximumTapeCartridgeCountExceeded",
|
|
"MaximumVolumeCountExceeded",
|
|
"NetworkConfigurationChanged",
|
|
"NoDisksAvailable",
|
|
"NotImplemented",
|
|
"NotSupported",
|
|
"OperationAborted",
|
|
"OutdatedGateway",
|
|
"ParametersNotImplemented",
|
|
"RegionInvalid",
|
|
"RequestTimeout",
|
|
"ServiceUnavailable",
|
|
"SnapshotDeleted",
|
|
"SnapshotIdInvalid",
|
|
"SnapshotInProgress",
|
|
"SnapshotNotFound",
|
|
"SnapshotScheduleNotFound",
|
|
"StagingAreaFull",
|
|
"StorageFailure",
|
|
"TapeCartridgeNotFound",
|
|
"TargetAlreadyExists",
|
|
"TargetInvalid",
|
|
"TargetNotFound",
|
|
"UnauthorizedOperation",
|
|
"VolumeAlreadyExists",
|
|
"VolumeIdInvalid",
|
|
"VolumeInUse",
|
|
"VolumeNotFound",
|
|
"VolumeNotReady"
|
|
],
|
|
"documentation": "\n <p>Additional information about the error.</p>\n "
|
|
},
|
|
"errorDetails": {
|
|
"shape_name": "errorDetails",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "string",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>Human-readable text that provides detail about the error that occured.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>An internal server error has occured during the request. See the error and message fields for more\n information.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>This operation updates a snapshot schedule configured for a gateway volume.</p>\n <p>The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume.\n You can use this API to change the shapshot schedule configured for the volume.</p>\n <p>In the request you must identify the gateway volume whose snapshot schedule you want to update, and the\n schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of\n snapshots.</p>\n <examples>\n <example>\n <name>Example Request</name>\n <description>The following example shows a request that updates a snapshot schedule.</description>\n <request>\nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 0,\n \"RecurrenceInHours\": 1,\n \"Description\": \"hourly snapshot\"\n}\n </request>\n <response>\nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n </response>\n </example>\n </examples>\n "
|
|
}
|
|
},
|
|
"metadata": {
|
|
"regions": {
|
|
"us-east-1": null,
|
|
"ap-northeast-1": null,
|
|
"sa-east-1": null,
|
|
"ap-southeast-1": null,
|
|
"ap-southeast-2": null,
|
|
"us-west-2": null,
|
|
"us-west-1": null,
|
|
"eu-west-1": null,
|
|
"us-gov-west-1": null,
|
|
"cn-north-1": "https://storagegateway.cn-north-1.amazonaws.com.cn"
|
|
},
|
|
"protocols": [
|
|
"https"
|
|
]
|
|
},
|
|
"retry": {
|
|
"__default__": {
|
|
"max_attempts": 5,
|
|
"delay": {
|
|
"type": "exponential",
|
|
"base": "rand",
|
|
"growth_factor": 2
|
|
},
|
|
"policies": {
|
|
"general_socket_errors": {
|
|
"applies_when": {
|
|
"socket_errors": [
|
|
"GENERAL_CONNECTION_ERROR"
|
|
]
|
|
}
|
|
},
|
|
"general_server_error": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 500
|
|
}
|
|
}
|
|
},
|
|
"service_unavailable": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 503
|
|
}
|
|
}
|
|
},
|
|
"limit_exceeded": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 509
|
|
}
|
|
}
|
|
},
|
|
"throttling": {
|
|
"applies_when": {
|
|
"response": {
|
|
"service_error_code": "ThrottlingException",
|
|
"http_status_code": 400
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |