Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
step-functions-dg-264	step-functions-dg.pdf	264	variable SFN_MOCK_CONFIG, Step Functions Local will read the ﬁle speciﬁed by the environment variable. Step 3: Run Mocked Service Integration Tests After you create and provide a mock conﬁguration ﬁle to Step Functions Local, run the state machine conﬁgured in the mock conﬁguration ﬁle using mocked service integrations. Then check the execution results using an API action. 1. Create a state machine based on the previously mentioned deﬁnition in the mock conﬁguration ﬁle. aws stepfunctions create-state-machine \ --endpoint http://localhost:8083 \ --definition "{\"Comment\":\"Thisstatemachineiscalled:LambdaSQSIntegration \",\"StartAt\":\"LambdaState\",\"States\":{\"LambdaState\":{\"Type\":\"Task\", Testing with mocked service integrations 972 AWS Step Functions Developer Guide \"Resource\":\"arn:aws:states:::lambda:invoke\",\"Parameters\":{\"Payload.$\":\"$ \",\"FunctionName\":\"arn:aws:lambda:region:account-id:function:HelloWorldFunction \"},\"Retry\":[{\"ErrorEquals\":[\"States.ALL\"],\"IntervalSeconds\":2, \"MaxAttempts\":3,\"BackoffRate\":2}],\"Next\":\"SQSState\"},\"SQSState\": {\"Type\":\"Task\",\"Resource\":\"arn:aws:states:::sqs:sendMessage\",\"Parameters \":{\"QueueUrl\":\"https://sqs.us-east-1.amazonaws.com/account-id/myQueue\", \"MessageBody.$\":\"$\"},\"End\":true}}}" \ --name "LambdaSQSIntegration" --role-arn "arn:aws:iam::account-id:role/service- role/LambdaSQSIntegration" 2. Run the state machine using mocked service integrations. To use the mock conﬁguration ﬁle, make a StartExecution API call on a state machine conﬁgured in the mock conﬁguration ﬁle. To do this, append the suﬃx, #test_name, to the state machine ARN used by StartExecution. test_name is a test case, which is conﬁgured for the state machine in the same mock conﬁguration ﬁle. The following command is an example that uses the LambdaSQSIntegration state machine and mock conﬁguration. In this example, the LambdaSQSIntegration state machine is executed using the HappyPath test deﬁned in Step 1: Specify Mocked Service Integrations in a Mock Conﬁguration File. The HappyPath test contains the conﬁguration for the execution to handle mock service integration calls that LambdaState and SQSState states make using the MockedLambdaSuccess and MockedSQSSuccess mocked service responses. aws stepfunctions start-execution \ --endpoint http://localhost:8083 \ --name executionWithHappyPathMockedServices \ --state-machine arn:aws:states:region:account- id:stateMachine:LambdaSQSIntegration#HappyPath 3. View the state machine execution response. The response to calling StartExecution using a mocked service integration test is same as the response to calling StartExecution normally, which returns the execution ARN and start date. The following is an example response to calling StartExecution using the mocked service integration test: { "startDate":"2022-01-28T15:03:16.981000-05:00", Testing with mocked service integrations 973 AWS Step Functions Developer Guide "executionArn":"arn:aws:states:region:account- id:execution:LambdaSQSIntegration:executionWithHappyPathMockedServices" } 4. Check the execution's results by making a ListExecutions, DescribeExecution, or GetExecutionHistory API call. aws stepfunctions get-execution-history \ --endpoint http://localhost:8083 \ --execution-arn arn:aws:states:region:account- id:execution:LambdaSQSIntegration:executionWithHappyPathMockedServices The following example demonstrates parts of a response to calling GetExecutionHistory using the execution ARN from the example response shown in step 2. In this example, the output of LambdaState and SQSState is the mock data deﬁned in MockedLambdaSuccess and MockedSQSSuccess in the mock conﬁguration ﬁle. In addition, the mocked data is used the same way that data returned by performing actual service integration calls would be used. Also, in this example, the output from LambdaState is passed onto SQSState as input. { "events": [ ... { "timestamp": "2021-12-02T19:39:48.988000+00:00", "type": "TaskStateEntered", "id": 2, "previousEventId": 0, "stateEnteredEventDetails": { "name": "LambdaState", "input": "{}", "inputDetails": { "truncated": false } } }, ... { "timestamp": "2021-11-25T23:39:10.587000+00:00", "type": "LambdaFunctionSucceeded", "id": 5, "previousEventId": 4, "lambdaFunctionSucceededEventDetails": { Testing with mocked service integrations 974 AWS Step Functions Developer Guide "output": "{\"statusCode\":200,\"body\":\"\\\"Hello from Lambda!\\ \"\"}", "outputDetails": { "truncated": false } } }, ... "timestamp": "2021-12-02T19:39:49.464000+00:00", "type": "TaskStateEntered", "id": 7, "previousEventId": 6, "stateEnteredEventDetails": { "name": "SQSState", "input": "{\"statusCode\":200,\"body\":\"\\\"Hello from Lambda!\\ \"\"}", "inputDetails": { "truncated": false } } }, ... { "timestamp": "2021-11-25T23:39:10.652000+00:00", "type": "TaskSucceeded", "id": 10, "previousEventId": 9, "taskSucceededEventDetails": { "resourceType": "sqs", "resource": "sendMessage", "output": "{\"MD5OfMessageBody\":\"3bcb6e8e-7h85-4375- b0bc-1a59812c6e51\",\"MessageId\":\"3bcb6e8e-8b51-4375-b0bc-1a59812c6e51\"}", "outputDetails": { "truncated": false } } }, ... ] } Testing with mocked service integrations 975 AWS Step Functions Developer Guide Conﬁguration ﬁle for mocked service integrations in Step Functions Step Functions Local is unsupported Step Functions Local does not provide feature parity and is unsupported. You might consider third party solutions that emulate Step Functions for testing purposes. To use mocked service integrations, you must ﬁrst create a mock conﬁguration ﬁle named MockConfigFile.json containing your mock conﬁgurations. Then provide Step Functions Local with the mock conﬁguration ﬁle. This conﬁguration ﬁle deﬁnes test cases, which contain mock states that use mocked service integration responses. The following section contains information about the structure of mock conﬁguration that includes the mock states and mocked responses: Mock conﬁguration ﬁle structure A mock conﬁguration is a JSON object containing the following top-level ﬁelds: • StateMachines - The ﬁelds of this object represent state machines conﬁgured to use mocked service integrations. • MockedResponse - The ﬁelds of this object represent mocked responses for service integration calls. The following is an example of a mock conﬁguration ﬁle which includes a StateMachine deﬁnition and MockedResponse. { "StateMachines":{ "LambdaSQSIntegration":{ "TestCases":{ "HappyPath":{ "LambdaState":"MockedLambdaSuccess", "SQSState":"MockedSQSSuccess" }, "RetryPath":{ "LambdaState":"MockedLambdaRetry", "SQSState":"MockedSQSSuccess" }, "HybridPath":{ "LambdaState":"MockedLambdaSuccess" Testing with mocked service integrations 976 Developer Guide AWS Step Functions } } } }, "MockedResponses":{ "MockedLambdaSuccess":{ "0":{ "Return":{ "StatusCode":200, "Payload":{ "StatusCode":200, "body":"Hello from Lambda!" } } } }, "LambdaMockedResourceNotReady":{ "0":{ "Throw":{ "Error":"Lambda.ResourceNotReadyException", "Cause":"Lambda resource is not ready." } } }, "MockedSQSSuccess":{ "0":{ "Return":{ "MD5OfMessageBody":"3bcb6e8e-7h85-4375-b0bc-1a59812c6e51", "MessageId":"3bcb6e8e-8b51-4375-b0bc-1a59812c6e51" } } }, "MockedLambdaRetry":{ "0":{ "Throw":{ "Error":"Lambda.ResourceNotReadyException", "Cause":"Lambda resource is not ready." } }, "1-2":{ "Throw":{ "Error":"Lambda.TimeoutException", "Cause":"Lambda timed out." } Testing
step-functions-dg-265	step-functions-dg.pdf	265	calls. The following is an example of a mock conﬁguration ﬁle which includes a StateMachine deﬁnition and MockedResponse. { "StateMachines":{ "LambdaSQSIntegration":{ "TestCases":{ "HappyPath":{ "LambdaState":"MockedLambdaSuccess", "SQSState":"MockedSQSSuccess" }, "RetryPath":{ "LambdaState":"MockedLambdaRetry", "SQSState":"MockedSQSSuccess" }, "HybridPath":{ "LambdaState":"MockedLambdaSuccess" Testing with mocked service integrations 976 Developer Guide AWS Step Functions } } } }, "MockedResponses":{ "MockedLambdaSuccess":{ "0":{ "Return":{ "StatusCode":200, "Payload":{ "StatusCode":200, "body":"Hello from Lambda!" } } } }, "LambdaMockedResourceNotReady":{ "0":{ "Throw":{ "Error":"Lambda.ResourceNotReadyException", "Cause":"Lambda resource is not ready." } } }, "MockedSQSSuccess":{ "0":{ "Return":{ "MD5OfMessageBody":"3bcb6e8e-7h85-4375-b0bc-1a59812c6e51", "MessageId":"3bcb6e8e-8b51-4375-b0bc-1a59812c6e51" } } }, "MockedLambdaRetry":{ "0":{ "Throw":{ "Error":"Lambda.ResourceNotReadyException", "Cause":"Lambda resource is not ready." } }, "1-2":{ "Throw":{ "Error":"Lambda.TimeoutException", "Cause":"Lambda timed out." } Testing with mocked service integrations 977 Developer Guide AWS Step Functions }, "3":{ "Return":{ "StatusCode":200, "Payload":{ "StatusCode":200, "body":"Hello from Lambda!" } } } } } } Mock conﬁguration ﬁeld reference The following sections explain the top-level object ﬁelds that you must deﬁne in your mock conﬁguration. • StateMachines • MockedResponses StateMachines The StateMachines object deﬁnes which state machines will use mocked service integrations. The conﬁguration for each state machine is represented as a top-level ﬁeld of StateMachines. The ﬁeld name is the name of the state machine and value is an object containing a single ﬁeld named TestCases, whose ﬁelds represent test cases of that state machine. The following syntax shows a state machine with two test cases: "MyStateMachine": { "TestCases": { "HappyPath": { ... }, "SadPath": { ... } } Testing with mocked service integrations 978 AWS Step Functions TestCases Developer Guide The ﬁelds of TestCases represent individual test cases for the state machine. The name of each test case must be unique per state machine and the value of each test case is an object specifying a mocked response to use for Task states in the state machine. The following example of a TestCase links two Task states to two MockedResponses: "HappyPath": { "SomeTaskState": "SomeMockedResponse", "AnotherTaskState": "AnotherMockedResponse" } MockedResponses MockedResponses is an object containing multiple mocked response objects with unique ﬁeld names. A mocked response object deﬁnes the successful result or error output for each invocation of a mocked Task state. You specify the invocation number using individual integer strings, such as “0”, “1”, “2”, and “3” or an inclusive range of integers, such as “0-1”, “2-3”. When you mock a Task, you must specify a mocked response for every invocation. A response must contain a single ﬁeld named Return or Throw whose value is the result or error output for the mocked Task invocation. If you do not specify a mocked response, the state machine execution will fail. The following is an example of a MockedResponse with Throw and Return objects. In this example, the ﬁrst three times the state machine is run, the response speciﬁed in "0-2" is returned, and the fourth time the state machine runs, the response speciﬁed in "3" is returned. "SomeMockedResponse": { "0-2": { "Throw": { ... } }, "3": { "Return": { ... } } } Testing with mocked service integrations 979 AWS Step Functions Note Developer Guide If you are using a Map state, and want to ensure predictable responses for the Map state, set the value of maxConcurrency to 1. If you set a value greater than 1, Step Functions Local will run multiple iterations concurrently, which will cause the overall execution order of states across iterations to be unpredictable. This may further cause Step Functions Local to use diﬀerent mocked responses for iteration states from one execution to the next. Return Return is represented as a ﬁeld of the MockedResponse objects. It speciﬁes the successful result of a mocked Task state. The following is an example of a Return object that contains a mocked response for calling Invoke on a Lambda function: "Return": { "StatusCode": 200, "Payload": { "StatusCode": 200, "body": "Hello from Lambda!" } } Throw Throw is represented as a ﬁeld of the MockedResponse objects. It speciﬁes the error output of a failed Task. The value of Throw must be an object containing an Error and Cause ﬁelds with string values. In addition, the string value you specify in Error ﬁeld in the MockConfigFile.json must match the errors handled in the Retry and Catch sections of your state machine. The following is an example of a Throw object that contains a mocked response for calling Invoke on a Lambda function: "Throw": { "Error": "Lambda.TimeoutException", "Cause": "Lambda timed out." } Testing with mocked service integrations 980 AWS Step Functions Developer Guide Manage continuous deployments with versions and aliases in Step Functions You can use Step Functions to manage continuous deployments of your workﬂows through state machine versions and aliases. A version is a numbered, immutable snapshot of a state machine that you can run. An alias is a pointer for up to two versions of a state machine. You can maintain multiple versions of your state machines and
step-functions-dg-266	step-functions-dg.pdf	266	object that contains a mocked response for calling Invoke on a Lambda function: "Throw": { "Error": "Lambda.TimeoutException", "Cause": "Lambda timed out." } Testing with mocked service integrations 980 AWS Step Functions Developer Guide Manage continuous deployments with versions and aliases in Step Functions You can use Step Functions to manage continuous deployments of your workﬂows through state machine versions and aliases. A version is a numbered, immutable snapshot of a state machine that you can run. An alias is a pointer for up to two versions of a state machine. You can maintain multiple versions of your state machines and manage their deployment in your production workﬂow. With aliases, you can route traﬃc between diﬀerent workﬂow versions and gradually deploy those workﬂows to the production environment. Additionally, you can start state machine executions using a version or an alias. If you don't use a version or alias when you start a state machine execution, Step Functions uses the latest revision of the state machine deﬁnition. State machine revision A state machine can have one or more revisions. When you update a state machine using the UpdateStateMachine API action, it creates a new state machine revision. A revision is an immutable, read-only snapshot of a state machine’s deﬁnition and conﬁguration. You can't start a state machine execution from a revision, and revisions don't have an ARN. Revisions have a revisionId, which is a universally unique identiﬁer (UUID). Contents • State machine versions in Step Functions workﬂows • State machine aliases in Step Functions workﬂows • Authorization for versions and aliases in Step Functions workﬂows • How Step Functions associates executions with a version or alias • Example: Alias and version deployment in Step Functions • Perform gradual deployment of state machine versions in Step Functions 981 AWS Step Functions Developer Guide State machine versions in Step Functions workﬂows A version is a numbered, immutable snapshot of a state machine. You publish versions from the most recent revision made to that state machine. Each version has a unique Amazon Resource Name (ARN) which is a combination of state machine ARN and the version number separated by a colon (:). The following example shows the format of a state machine version ARN. arn:partition:states:region:account-id:stateMachine:myStateMachine:1 To start using state machine versions, you must publish the ﬁrst version. After you publish a version, you can invoke the StartExecution API action with the version ARN. You can't edit a version, but you can update a state machine and publish a new version. You can also publish multiple versions of your state machine. When you publish a new version of your state machine, Step Functions assigns it a version number. Version numbers start at 1 and increase monotonically for each new version. Version numbers aren't reused for a given state machine. If you delete version 10 of your state machine and then publish a new version, Step Functions publishes it as version 11. The following properties are the same for all versions of a state machine: • All versions of a state machine share the same type (Standard or Express). • You can't change the name or creation date of a state machine between versions. • Tags apply globally to state machines. You can manage tags for state machines using the TagResource and UntagResource API actions. State machines also contain properties that are a part of each version and revision, but these properties can diﬀer between two given versions or revisions. These properties include State machine deﬁnition, IAM role, tracing conﬁguration, and logging conﬁguration. Versions 982 AWS Step Functions Developer Guide Publishing a state machine version (Console) You can publish up to 1000 versions of a state machine. To request an increase to this soft limit, use the Support Center page in the AWS Management Console. You can manually delete unused versions from the console or by invoking the DeleteStateMachineVersion API action. To publish a state machine version 1. Open the Step Functions console, and then choose an existing state machine. 2. On the State machine detail page, choose Edit. 3. Edit the state machine deﬁnition as required, and then choose Save. 4. Choose Publish version. 5. (Optional) In the Description ﬁeld of the dialog box that appears, enter a brief description about the state machine version. 6. Choose Publish. Note When you publish a new version of your state machine, Step Functions assigns it a version number. Version numbers start at 1 and increase monotonically for each new version. Version numbers aren't reused for a given state machine. If you delete version 10 of your state machine and then publish a new version, Step Functions publishes it as version 11. Managing versions with Step Functions API operations Step Functions provides the following API operations to publish and manage state machine versions: • PublishStateMachineVersion – Publishes a version
step-functions-dg-267	step-functions-dg.pdf	267	enter a brief description about the state machine version. 6. Choose Publish. Note When you publish a new version of your state machine, Step Functions assigns it a version number. Version numbers start at 1 and increase monotonically for each new version. Version numbers aren't reused for a given state machine. If you delete version 10 of your state machine and then publish a new version, Step Functions publishes it as version 11. Managing versions with Step Functions API operations Step Functions provides the following API operations to publish and manage state machine versions: • PublishStateMachineVersion – Publishes a version from the current revision of a state machine. • UpdateStateMachine – Publishes a new state machine version if you update a state machine and set the publish parameter to true in the same request. • CreateStateMachine – Publishes the ﬁrst revision of the state machine if you set the publish parameter to true. • ListStateMachineVersions – Lists versions for the speciﬁed state machine ARN. Publishing a state machine version (Console) 983 AWS Step Functions Developer Guide • DescribeStateMachine – Returns the state machine version details for a version ARN speciﬁed in stateMachineArn. • DeleteStateMachineVersion – Deletes a state machine version. To publish a new version from the current revision of a state machine called myStateMachine using the AWS Command Line Interface, use the publish-state-machine-version command: aws stepfunctions publish-state-machine-version --state-machine-arn arn:aws:states:region:account-id:stateMachine:myStateMachine The response returns the stateMachineVersionArn. For example, the previous command returns a response ofarn:aws:states:region:account- id:stateMachine:myStateMachine:1. Note When you publish a new version of your state machine, Step Functions assigns it a version number. Version numbers start at 1 and increase monotonically for each new version. Version numbers aren't reused for a given state machine. If you delete version 10 of your state machine and then publish a new version, Step Functions publishes it as version 11. Running a state machine version from the console To start using state machine versions, you must ﬁrst publish a version from the current state machine revision. To publish a version, use the Step Functions console or invoke the PublishStateMachineVersion API action. You can also invoke the UpdateStateMachineAlias API action with an optional parameter named publish to update a state machine and publish its version. You can start executions of a version by using the console or by invoking the StartExecution API action and providing the version ARN. You can also use an alias to start executions of a version. Based on its routing conﬁguration, an alias routes traﬃc to a speciﬁc version. If you start a state machine execution without using a version, Step Functions uses the most recent revision of the state machine for the execution. For information about how Step Functions associates an execution with a version, see Associating executions with a version or alias. Running a state machine version from the console 984 AWS Step Functions Developer Guide To start an execution using a state machine version 1. Open the Step Functions console, and then choose an existing state machine that you've published one or more versions for. To learn how to publish a version, see Publishing a state machine version (Console). 2. On the State machine detail page, choose the Versions tab. 3. In the Versions section, do the following: a. Select the version that you want to start the execution with. b. Choose Start execution. 4. 5. (Optional) In the Start execution dialog box, enter a name for the execution. (Optional) , enter the execution input, and then choose Start execution. State machine aliases in Step Functions workﬂows An alias is a pointer for up to two versions of the same state machine. You can create multiple aliases for your state machines. Each alias has a unique Amazon Resource Name (ARN). The alias ARN is a combination of the state machine's ARN and the alias name, separated by a colon (:). The following example shows the format of a state machine alias ARN. arn:partition:states:region:account-id:stateMachine:myStateMachine:aliasName You can use an alias to route traﬃc between one of the two state machine versions. You can also create an alias that points to a single version. Aliases can only point to state machine versions. You can't use an alias to point to another alias. You can also update an alias to point to a diﬀerent version of the state machine. Contents • Creating a state machine alias (Console) Aliases 985 AWS Step Functions Developer Guide • Managing aliases with Step Functions API operations • Alias routing conﬁguration • Running a state machine using an alias (Console) Creating a state machine alias (Console) You can create up to 100 aliases for each state machine by using the Step Functions console or by invoking the CreateStateMachineAlias API action. To request an increase to this soft limit, use the Support Center page in the AWS Management
step-functions-dg-268	step-functions-dg.pdf	268	alias. You can also update an alias to point to a diﬀerent version of the state machine. Contents • Creating a state machine alias (Console) Aliases 985 AWS Step Functions Developer Guide • Managing aliases with Step Functions API operations • Alias routing conﬁguration • Running a state machine using an alias (Console) Creating a state machine alias (Console) You can create up to 100 aliases for each state machine by using the Step Functions console or by invoking the CreateStateMachineAlias API action. To request an increase to this soft limit, use the Support Center page in the AWS Management Console. Delete unused aliases from the console or by invoking the DeleteStateMachineAlias API action. To create a state machine alias 1. Open the Step Functions console, and then choose an existing state machine. 2. On the State machine detail page, choose the Aliases tab. 3. Choose Create new alias. 4. On the Create alias page, do the following: a. b. Enter an Alias name. (Optional) Enter a Description for the alias. 5. To conﬁgure routing on the alias, see Alias routing conﬁguration. 6. Choose Create alias. Managing aliases with Step Functions API operations Step Functions provides the following API operations that you can use to create and manage state machine aliases or get information about the aliases: • CreateStateMachineAlias – Creates an alias for a state machine. • DescribeStateMachineAlias – Returns details about a state machine alias. • ListStateMachineAliases – Lists aliases for the speciﬁed state machine ARN. • UpdateStateMachineAlias – Updates the conﬁguration of an existing state machine alias by modifying its description or routingConfiguration. • DeleteStateMachineAlias – Deletes a state machine version. Creating a state machine alias (Console) 986 AWS Step Functions Developer Guide To create an alias named PROD that points to version 1 of a state machine named myStateMachine using the AWS Command Line Interface, use the create-state-machine- alias command. aws stepfunctions create-state-machine-alias --name PROD --routing- configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:region:account- id:stateMachine:myStateMachine:1\",\"weight\":100}]" Alias routing conﬁguration You can use an alias to route execution traﬃc between two versions of a state machine. For example, say you want to launch a new version of your state machine. You can reduce the risks involved in deploying the new version by conﬁguring routing on an alias. By conﬁguring routing, you can send most of your traﬃc to an earlier, tested version of your state machine. The new version can then receive a smaller percentage, until you can conﬁrm that it's safe to roll forward the new version. To deﬁne routing conﬁguration, make sure that you publish both state machine versions that your alias points to. When you start an execution from an alias, Step Functions randomly chooses the state machine version to run from the versions speciﬁed in the routing conﬁguration. It bases this choice on the traﬃc percentage that you assign to each version in the alias routing conﬁguration. To conﬁgure routing conﬁguration on an alias • On the Create alias page, under Routing conﬁguration, do the following: a. b. c. d. For Version, choose the ﬁrst state machine version that the alias points to. Select the Split traﬃc between two versions check box. Tip To point to a single version, clear the Split traﬃc between two versions check box. For Version, choose the second version that the alias must point to. In the Traﬃc percentage ﬁelds, specify the percentage of traﬃc to route to each version. For example, enter 60 and 40 to route 60 percent of the execution traﬃc to the ﬁrst version and 40 percent traﬃc to the second version. Alias routing conﬁguration 987 AWS Step Functions Developer Guide The combined traﬃc percentages must equal to 100 percent. Running a state machine using an alias (Console) You can start state machine executions with an alias from either the console or by invoking the StartExecution API action with the alias' ARN. Step Functions then runs the version speciﬁed by the alias. By default, if you don't specify a version or alias when you start a state machine execution, Step Functions uses the most recent revision. To start a state machine execution using an alias 1. Open the Step Functions console, then choose an existing state machine that you've created an alias for. For information about creating an alias, see Creating a state machine alias (Console). 2. On the State machine detail page, choose the Aliases tab. 3. In the Aliases section, do the following: a. Select the alias that you want to start the execution with. b. Choose Start execution. 4. 5. (Optional) In the Start execution dialog box, enter a name for the execution. If required, enter the execution input, and then choose Start execution. Authorization for versions and aliases in Step Functions workﬂows To invoke Step Functions API actions with a version or an alias, you need appropriate
step-functions-dg-269	step-functions-dg.pdf	269	alias for. For information about creating an alias, see Creating a state machine alias (Console). 2. On the State machine detail page, choose the Aliases tab. 3. In the Aliases section, do the following: a. Select the alias that you want to start the execution with. b. Choose Start execution. 4. 5. (Optional) In the Start execution dialog box, enter a name for the execution. If required, enter the execution input, and then choose Start execution. Authorization for versions and aliases in Step Functions workﬂows To invoke Step Functions API actions with a version or an alias, you need appropriate permissions. To authorize a version or an alias to invoke an API action, Step Functions uses the state machine’s ARN instead of using the version ARN or alias ARN. You can also scope down the permissions for a speciﬁc version or alias. For more information, see Scoping down permissions. You can use the following IAM policy example of a state machine named myStateMachine to invoke the CreateStateMachineAlias API action to create a state machine alias. { "Version": "2012-10-17", "Statement": [ Running a state machine using an alias (Console) 988 AWS Step Functions { Developer Guide "Effect": "Allow", "Action": "states:CreateStateMachineAlias", "Resource": "arn:aws:states:region:account-id:stateMachine:myStateMachine" } ] } When you set permissions to allow or deny access to API actions using state machine versions or aliases, consider the following: • If you use the publish parameter of the CreateStateMachine and UpdateStateMachine API actions to publish a new state machine version, you also need the ALLOW permission on the PublishStateMachineVersion API action. • The DeleteStateMachine API action deletes all versions and aliases associated with a state machine. Scoping down permissions for a version or alias You can use a qualiﬁer to further scope down the authorization permission needed by a version or an alias. A qualiﬁer refers to a version number or an alias name. You use the qualiﬁer to qualify a state machine. The following example is a state machine ARN that uses an alias named PROD as the qualiﬁer. arn:aws:states:region:account-id:stateMachine:myStateMachine:PROD For more information about qualiﬁed and unqualiﬁed ARNs, see Associating executions with a version or alias. You scope down the permissions using the optional context key named states:StateMachineQualifier in an IAM policy's Condition statement. For example, the following IAM policy for a state machine named myStateMachine denies access to invoke the DescribeStateMachine API action with an alias named as PROD or the version 1. { "Version": "2012-10-17", "Statement": [ { "Effect": "Deny", Scoping down permissions 989 AWS Step Functions Developer Guide "Action": "states:DescribeStateMachine", "Resource": "arn:aws:states:region:account-id:stateMachine:myStateMachine", "Condition": { "ForAnyValue:StringEquals": { "states:StateMachineQualifier": [ "PROD", "1" ] } } } ] } The following list speciﬁes the API actions on which you can scope down the permissions with the StateMachineQualifier context key. • CreateStateMachineAlias • DeleteStateMachineAlias • DeleteStateMachineVersion • DescribeStateMachine • DescribeStateMachineAlias • ListExecutions • ListStateMachineAliases • StartExecution • StartSyncExecution • UpdateStateMachineAlias How Step Functions associates executions with a version or alias Step Functions associates an execution with a version or alias based on the Amazon Resource Name (ARN) that you use to invoke the StartExecution API action. Step Functions performs this action at the execution start time. You can start a state machine execution using a qualiﬁed or an unqualiﬁed ARN. Associating executions with a version or alias 990 AWS Step Functions Developer Guide • Qualiﬁed ARN – Refers to a state machine ARN suﬃxed with a version number or an alias name. The following qualiﬁed ARN example refers to version 3 of a state machine named myStateMachine. arn:aws:states:region:account-id:stateMachine:myStateMachine:3 The following qualiﬁed ARN example refers to an alias named PROD of a state machine named myStateMachine. arn:aws:states:region:account-id:stateMachine:myStateMachine:PROD • Unqualiﬁed ARN – Refers to a state machine ARN without a version number or an alias name suﬃx. arn:aws:states:region:account-id:stateMachine:myStateMachine For example, if your qualiﬁed ARN refers to version 3, Step Functions associates the execution with this version. It doesn't associate the execution with any aliases that point to the version 3. If your qualiﬁed ARN refers to an alias, Step Functions associates the execution with that alias and the version to which the alias points. An execution can only be associated with one alias. Note If you start an execution with an unqualiﬁed ARN, Step Functions doesn't associate that execution with a version even if the version uses the same state machine revision. For example, if version 3 uses the latest revision, but you start an execution with an unqualiﬁed ARN, Step Functions doesn't associate that execution with the version 3. Viewing executions started with a version or an alias Step Functions provides the following ways in which you can view the executions started with a version or an alias: Viewing executions started with a version or an alias 991 AWS Step Functions Using API actions Developer Guide You can view all the executions associated with a
step-functions-dg-270	step-functions-dg.pdf	270	associate that execution with a version even if the version uses the same state machine revision. For example, if version 3 uses the latest revision, but you start an execution with an unqualiﬁed ARN, Step Functions doesn't associate that execution with the version 3. Viewing executions started with a version or an alias Step Functions provides the following ways in which you can view the executions started with a version or an alias: Viewing executions started with a version or an alias 991 AWS Step Functions Using API actions Developer Guide You can view all the executions associated with a version or an alias by invoking the DescribeExecution and ListExecutions API actions. These API actions return the ARN of the version or alias that was used to start the execution. These actions also return other details including status and ARN of the execution. You can also provide a state machine alias ARN or version ARN to list the executions associated with a speciﬁc alias or version. The following example response of the ListExecutions API action shows the ARN of the alias used to start a state machine execution named myFirstExecution. The italicized text in the following code snippet represents resource-speciﬁc information. { "executions": [ { "executionArn": "arn:aws:states:region:account- id:execution:myStateMachine:myFirstExecution", "stateMachineArn": "arn:aws:states:region:account- id:stateMachine:myStateMachine", "stateMachineAliasArn": "arn:aws:states:region:account- id:stateMachine:myStateMachine:PROD", "name": "myFirstExecution", "status": "SUCCEEDED", "startDate": "2023-04-20T23:07:09.477000+00:00", "stopDate": "2023-04-20T23:07:09.732000+00:00" } ] } Using Step Functions console You can also view the executions started by a version or an alias from the Step Functions console. The following procedure shows how you can view the executions started with a speciﬁc version: 1. Open the Step Functions console, and then choose an existing state machine for which you've published a version or created an alias. This example shows how to view the executions started with a speciﬁc state machine version. 2. Choose the Versions tab, and then choose a version from the Versions list. Viewing executions started with a version or an alias 992 AWS Step Functions Tip Developer Guide Filter by property or value box to search for a speciﬁc version. 3. On the Version details page, you can see a list of all the in-progress and past state machine executions started with the selected version. The following image shows the Version Details console page. This page lists executions started by the version 4 of a state machine named MathAddDemo. This list also displays an execution that was started by an alias named PROD. This alias routed the execution traﬃc to version 4. Using CloudWatch metrics For each state machine execution that you start with a Qualiﬁed ARN, Step Functions emits additional metrics with the same name and value as the metrics emitted currently. These additional metrics contain dimensions for each of the version identiﬁer and alias name with which you start an execution. With these metrics, you can monitor state machine executions at the version level and determine when a rollback scenario might be necessary. You can also create Amazon CloudWatch alarms based on these metrics. Viewing executions started with a version or an alias 993 AWS Step Functions Developer Guide Step Functions emits the following metrics for executions that you start with an alias or a version: • ExecutionTime • ExecutionsAborted • ExecutionsFailed • ExecutionsStarted • ExecutionsSucceeded • ExecutionsTimedOut If you started the execution with a version ARN, Step Functions publishes the metric with the StateMachineArn and a second metric with StateMachineArn and Version dimensions. If you started the execution with an alias ARN, Step Functions emits the following metrics: • Two metrics for the unqualiﬁed ARN and version. • A metric with the StateMachineArn and Alias dimensions. Example: Alias and version deployment in Step Functions The following example of the Canary deployment technique shows how you can deploy a new state machine version with the AWS Command Line Interface. In this example, the alias you create routes 20 percent of execution traﬃc to the new version. It then routes the remaining 80 percent the earlier version. To deploy a new state machine version and shift execution traﬃc with an alias, complete the following steps: 1. Publish a version from the current state machine revision. Use the publish-state-machine-version command in the AWS CLI to publish a version from the current revision of a state machine called myStateMachine: aws stepfunctions publish-state-machine-version --state-machine-arn arn:aws:states:region:account-id:stateMachine:myStateMachine The response returns the stateMachineVersionArn of the version that you published. For example, arn:aws:states:region:account-id:stateMachine:myStateMachine:1. 2. Create an alias that points to the state machine version. Deployment example 994 AWS Step Functions Developer Guide Use the create-state-machine-alias command to create an alias named PROD that points to version 1 of myStateMachine: aws stepfunctions create-state-machine-alias --name PROD --routing- configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:region:account- id:stateMachine:myStateMachine:1\",\"weight\":100}]" 3. Verify that executions started by the alias use correct published version. Start a new execution of myStateMachine by providing the ARN of the alias PROD
step-functions-dg-271	step-functions-dg.pdf	271	from the current revision of a state machine called myStateMachine: aws stepfunctions publish-state-machine-version --state-machine-arn arn:aws:states:region:account-id:stateMachine:myStateMachine The response returns the stateMachineVersionArn of the version that you published. For example, arn:aws:states:region:account-id:stateMachine:myStateMachine:1. 2. Create an alias that points to the state machine version. Deployment example 994 AWS Step Functions Developer Guide Use the create-state-machine-alias command to create an alias named PROD that points to version 1 of myStateMachine: aws stepfunctions create-state-machine-alias --name PROD --routing- configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:region:account- id:stateMachine:myStateMachine:1\",\"weight\":100}]" 3. Verify that executions started by the alias use correct published version. Start a new execution of myStateMachine by providing the ARN of the alias PROD in the start- execution command: aws stepfunctions start-execution --state-machine-arn arn:aws:states:region:account- id:stateMachineAlias:myStateMachine:PROD --input "{}" If you provide the state machine ARN in the StartExecution request, it uses the most recent revision of the state machine instead of the version speciﬁed in your alias for starting the execution. 4. Update the state machine deﬁnition and publish a new version. Update myStateMachine and publish its new version. To do this, use the optional publish parameter of the update-state-machine command: aws stepfunctions update-state-machine --state-machine-arn arn:aws:states:region:account-id:stateMachine:myStateMachine --definition $UPDATED_STATE_MACHINE_DEFINITION --publish The response returns the stateMachineVersionArn for the new version. For example, arn:aws:states:region:account-id:stateMachine:myStateMachine:2. 5. Update the alias to point to both the versions and set the alias' routing conﬁguration. Use the update-state-machine-alias command to update the routing conﬁguration of the alias PROD. Conﬁgure the alias so that 80 percent of the execution traﬃc goes to version 1 and the remaining 20 percent goes to version 2: Deployment example 995 AWS Step Functions Developer Guide aws stepfunctions update-state-machine-alias --state-machine-alias-arn arn:aws:states:region:account-id:stateMachineAlias:myStateMachine:PROD --routing- configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:region:account- id:stateMachine:myStateMachine:1\",\"weight\":80}, {\"stateMachineVersionArn\": \"arn:aws:states:region:account-id:stateMachine:myStateMachine:2\",\"weight\":20}]" 6. Replace version 1 with version 2. After you verify that your new state machine version works correctly, you can deploy the new state machine version. To do this, update the alias again to assign 100 percent of execution traﬃc to the new version. Use the update-state-machine-alias command to set the routing conﬁguration of the alias PROD to 100 percent for version 2: aws stepfunctions update-state-machine-alias --state-machine-alias-arn arn:aws:states:region:account-id:stateMachineAlias:myStateMachine:PROD --routing- configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:region:account- id:stateMachine:myStateMachine:2\",\"weight\":100}]" Tip To roll back the deployment of version 2, edit the alias' routing conﬁguration to shift 100 percent of traﬃc to the newly deployed version. aws stepfunctions update-state-machine-alias --state-machine-alias-arn arn:aws:states:region:account- id:stateMachineAlias:myStateMachine:PROD --routing-configuration "[{\"stateMachineVersionArn\": \"arn:aws:states:region:account-id:stateMachine:myStateMachine:1\",\"weight \":100}]" You can use versions and aliases to perform other types of deployments. For instance, you can perform a rolling deployment of a new version of your state machine. To do so, gradually increase the weighted percentage in the routing conﬁguration of the alias that points to the new version. Deployment example 996 AWS Step Functions Developer Guide You can also use versions and aliases to perform a blue/green deployment. To do so, create an alias named green that runs the current version 1 of your state machine. Then, create another alias named blue that runs the new version, for example, 2. To test the new version, send execution traﬃc to the blue alias. When you're conﬁdent that your new version works correctly, update the green alias to point to your new version. Perform gradual deployment of state machine versions in Step Functions A rolling deployment is a deployment strategy that slowly replaces previous versions of an application with new versions of an application. To perform a rolling deployment of a state machine version, gradually send an increasing amount of execution traﬃc to the new version. The amount of traﬃc and rate of increase are parameters that you conﬁgure. You can perform rolling deployment of a version using one of the following options: • Step Functions console – Create an alias that points to two versions of the same state machine. For this alias, you conﬁgure the routing conﬁguration to shift traﬃc between the two versions. For more information about using the console to roll out versions, see Versions and Aliases. • Scripts for AWS CLI and SDK – Create a shell script using the AWS CLI or the AWS SDK. For more information, see the following sections for using AWS CLI and AWS SDK. • AWS CloudFormation templates – Use the AWS::StepFunctions::StateMachineVersion and AWS::StepFunctions::StateMachineAlias resources to publish multiple state machine versions and create an alias to point to one or two of these versions. Use the AWS CLI to deploy a new state machine version The example script in this section shows how you can use the AWS CLI to gradually shift traﬃc from a previous state machine version to a new state machine version. You can either use this example script or update it according to your requirements. This script shows a Canary deployment for deploying a new state machine version using an alias. The following steps outline the tasks that the script performs: 1. If the publish_revision parameter is set to true, publish the most recent revision as the next version of the
step-functions-dg-272	step-functions-dg.pdf	272	the AWS CLI to deploy a new state machine version The example script in this section shows how you can use the AWS CLI to gradually shift traﬃc from a previous state machine version to a new state machine version. You can either use this example script or update it according to your requirements. This script shows a Canary deployment for deploying a new state machine version using an alias. The following steps outline the tasks that the script performs: 1. If the publish_revision parameter is set to true, publish the most recent revision as the next version of the state machine. This version becomes the new, live version if the deployment succeeds. Gradual deployment of versions 997 AWS Step Functions Developer Guide If you set the publish_revision parameter to false, the script deploys the last published version of the state machine. 2. Create an alias if it doesn't exist yet. If the alias doesn't exist, point 100 percent of traﬃc for this alias to the new version, and then exit the script. 3. Update the routing conﬁguration of the alias to shift a small percentage of traﬃc from the previous version to the new version. You set this canary percentage with the canary_percentage parameter. 4. By default, monitor the conﬁgurable CloudWatch alarms every 60 seconds. If any of these alarms set oﬀ, rollback the deployment immediately by pointing 100 percent of traﬃc to the previous version. After every time interval, in seconds, deﬁned in alarm_polling_interval, continue monitoring the alarms. Continue monitoring until the time interval deﬁned in canary_interval_seconds has passed. 5. If no alarms were set oﬀ during canary_interval_seconds, shift 100 percent of traﬃc to the new version. 6. If the new version deploys successfully, delete any versions older than the number speciﬁed in the history_max parameter. #!/bin/bash # # AWS StepFunctions example showing how to create a canary deployment with a # State Machine Alias and versions. # # Requirements: AWS CLI installed and credentials configured. # # A canary deployment deploys the new version alongside the old version, while # routing only a small fraction of the overall traffic to the new version to # see if there are any errors. Only once the new version has cleared a testing # period will it start receiving 100% of traffic. # # For a Blue/Green or All at Once style deployment, you can set the # canary_percentage to 100. The script will immediately shift 100% of traffic # to the new version, but keep on monitoring the alarms (if any) during the # canary_interval_seconds time interval. If any alarms raise during this period, # the script will automatically rollback to the previous version. # Gradual deployment of versions 998 AWS Step Functions Developer Guide # Step Functions allows you to keep a maximum of 1000 versions in version history # for a state machine. This script has a version history deletion mechanism at # the end, where it will delete any versions older than the limit specified. # # For an example that also demonstrates linear (or rolling) deployments, see the following: # https://github.com/aws-samples/aws-stepfunctions-examples/blob/main/gradual-deploy/ sfndeploy.py set -euo pipefail # **************************************************************************** # you can safely change the variables in this block to your values state_machine_name="my-state-machine" alias_name="alias-1" region="us-east-1" # array of cloudwatch alarms to poll during the test period. # to disable alarm checking, set alarm_names=() alarm_names=("alarm1" "alarm name with a space") # true to publish the current revision as the next version before deploy. # false to deploy the latest version from the state machine's version history. publish_revision=true # true to force routing configuration update even if the current routing # for the alias does not have a 100% routing config. # false will abandon deploy attempt if current routing config not 100% to a # single version. # Be careful when you combine this flag with publish_revision - if you just # rerun the script you might deploy the newly published revision from the # previous run. force=false # percentage of traffic to route to the new version during the test period canary_percentage=10 # how many seconds the canary deployment lasts before full deploy to 100% canary_interval_seconds=300 # how often to poll the alarms alarm_polling_interval=60 # how many versions to keep in history. delete versions prior to this. Gradual deployment of versions 999 AWS Step Functions Developer Guide # set to 0 to disable old version history deletion. history_max=0 # **************************************************************************** ####################################### # Update alias routing configuration. # # If you don't specify version 2 details, will only create 1 routing entry. In # this case the routing entry weight must be 100. # # Globals: # alias_arn # Arguments: # 1. version 1 arn # 2. version 1 weight # 3. version 2 arn (optional) # 4. version 2 weight (optional) ####################################### function update_routing() { if [[
step-functions-dg-273	step-functions-dg.pdf	273	versions to keep in history. delete versions prior to this. Gradual deployment of versions 999 AWS Step Functions Developer Guide # set to 0 to disable old version history deletion. history_max=0 # **************************************************************************** ####################################### # Update alias routing configuration. # # If you don't specify version 2 details, will only create 1 routing entry. In # this case the routing entry weight must be 100. # # Globals: # alias_arn # Arguments: # 1. version 1 arn # 2. version 1 weight # 3. version 2 arn (optional) # 4. version 2 weight (optional) ####################################### function update_routing() { if [[ $# -eq 2 ]]; then local routing_config="[{\"stateMachineVersionArn\": \"$1\", \"weight\":$2}]" elif [[ $# -eq 4 ]]; then local routing_config="[{\"stateMachineVersionArn\": \"$1\", \"weight\":$2}, {\"stateMachineVersionArn\": \"$3\", \"weight\":$4}]" else echo "You have to call update_routing with either 2 or 4 input arguments." >&2 exit 1 fi ${aws} update-state-machine-alias --state-machine-alias-arn ${alias_arn} --routing- configuration "${routing_config}" } # **************************************************************************** # pre-run validation if [[ (("${#alarm_names[@]}" -gt 0)) ]]; then alarm_exists_count=$(aws cloudwatch describe-alarms --alarm-names "${alarm_names[@]}" --alarm-types "CompositeAlarm" "MetricAlarm" --query "length([MetricAlarms, CompositeAlarms][])" --output text) if [[ (("${#alarm_names[@]}" -ne "${alarm_exists_count}")) ]]; then echo All of the alarms to monitor do not exist in CloudWatch: $(IFS=,; echo "${alarm_names[]}") >&2 echo Only the following alarm names exist in CloudWatch: Gradual deployment of versions 1000 AWS Step Functions Developer Guide aws cloudwatch describe-alarms --alarm-names "${alarm_names[@]}" --alarm-types "CompositeAlarm" "MetricAlarm" --query "join(', ', [MetricAlarms, CompositeAlarms] [].AlarmName)" --output text exit 1 fi fi if [[ (("${history_max}" -gt 0)) && (("${history_max}" -lt 2)) ]]; then echo The minimum value for history_max is 2. This is the minimum number of older state machine versions to be able to rollback in the future. >&2 exit 1 fi # ***************************************************************************** # main block follows account_id=$(aws sts get-caller-identity --query Account --output text) sm_arn="arn:aws:states:${region}:${account_id}:stateMachine:${state_machine_name}" # the aws command we'll be invoking a lot throughout. aws="aws stepfunctions" # promote the latest revision to the next version if [[ "${publish_revision}" = true ]]; then new_version=$(${aws} publish-state-machine-version --state-machine-arn=$sm_arn -- query stateMachineVersionArn --output text) echo Published the current revision of state machine as the next version with arn: ${new_version} else new_version=$(${aws} list-state-machine-versions --state-machine-arn ${sm_arn} --max- results 1 --query "stateMachineVersions[0].stateMachineVersionArn" --output text) echo "Since publish_revision is false, using the latest version from the state machine's version history: ${new_version}" fi # find the alias if it exists alias_arn_expected="${sm_arn}:${alias_name}" alias_arn=$(${aws} list-state-machine-aliases --state-machine-arn ${sm_arn} --query "stateMachineAliases[?stateMachineAliasArn==\` ${alias_arn_expected}\`].stateMachineAliasArn" --output text) if [[ "${alias_arn_expected}" == "${alias_arn}" ]]; then echo Found alias ${alias_arn} Gradual deployment of versions 1001 AWS Step Functions Developer Guide echo Current routing configuration is: ${aws} describe-state-machine-alias --state-machine-alias-arn "${alias_arn}" --query routingConfiguration else echo Alias does not exist. Creating alias ${alias_arn_expected} and routing 100% traffic to new version ${new_version} ${aws} create-state-machine-alias --name "${alias_name}" --routing-configuration "[{\"stateMachineVersionArn\": \"${new_version}\", \"weight\":100}]" echo Done! exit 0 fi # find the version to which the alias currently points (the current live version) old_version=$(${aws} describe-state-machine-alias --state-machine-alias-arn $alias_arn --query "routingConfiguration[?weight==\`100\`].stateMachineVersionArn" --output text) if [[ -z "${old_version}" ]]; then if [[ "${force}" = true ]]; then echo Force setting is true. Will force update to routing config for alias to point 100% to new version. update_routing "${new_version}" 100 echo Alias ${alias_arn} now pointing 100% to ${new_version}. echo Done! exit 0 else echo Alias ${alias_arn} does not have a routing config entry with 100% of the traffic. This means there might be a deploy in progress, so not starting another deploy at this time. >&2 exit 1 fi fi if [[ "${old_version}" == "${new_version}" ]]; then echo The alias already points to this version. No update necessary. exit 0 fi echo Switching ${canary_percentage}% to new version ${new_version} (( old_weight = 100 - ${canary_percentage} )) update_routing "${new_version}" ${canary_percentage} "${old_version}" ${old_weight} Gradual deployment of versions 1002 AWS Step Functions Developer Guide echo New version receiving ${canary_percentage}% of traffic. echo Old version ${old_version} is still receiving ${old_weight}%. if [[ ${#alarm_names[@]} -eq 0 ]]; then echo No alarm_names set. Skipping cloudwatch monitoring. echo Will sleep for ${canary_interval_seconds} seconds before routing 100% to new version. sleep ${canary_interval_seconds} echo Canary period complete. Switching 100% of traffic to new version... else echo Checking if alarms fire for the next ${canary_interval_seconds} seconds. (( total_wait = canary_interval_seconds + $(date +%s) )) now=$(date +%s) while [[ ((${now} -lt ${total_wait})) ]]; do alarm_result=$(aws cloudwatch describe-alarms --alarm-names "${alarm_names[@]}" --state-value ALARM --alarm-types "CompositeAlarm" "MetricAlarm" --query "join(', ', [MetricAlarms, CompositeAlarms][].AlarmName)" --output text) if [[ ! -z "${alarm_result}" ]]; then echo The following alarms are in ALARM state: ${alarm_result}. Rolling back deploy. >&2 update_routing "${old_version}" 100 echo Rolled back to ${old_version} exit 1 fi echo Monitoring alarms...no alarms have triggered. sleep ${alarm_polling_interval} now=$(date +%s) done echo No alarms detected during canary period. Switching 100% of traffic to new version... fi update_routing "${new_version}" 100 echo Version ${new_version} is now receiving 100% of traffic. if [[ (("${history_max}" -eq 0 ))]]; then Gradual deployment of versions 1003 AWS Step Functions Developer Guide echo Version History deletion is disabled. Remember to
step-functions-dg-274	step-functions-dg.pdf	274	"join(', ', [MetricAlarms, CompositeAlarms][].AlarmName)" --output text) if [[ ! -z "${alarm_result}" ]]; then echo The following alarms are in ALARM state: ${alarm_result}. Rolling back deploy. >&2 update_routing "${old_version}" 100 echo Rolled back to ${old_version} exit 1 fi echo Monitoring alarms...no alarms have triggered. sleep ${alarm_polling_interval} now=$(date +%s) done echo No alarms detected during canary period. Switching 100% of traffic to new version... fi update_routing "${new_version}" 100 echo Version ${new_version} is now receiving 100% of traffic. if [[ (("${history_max}" -eq 0 ))]]; then Gradual deployment of versions 1003 AWS Step Functions Developer Guide echo Version History deletion is disabled. Remember to prune your history, the default limit is 1000 versions. echo Done! exit 0 fi echo Keep the last ${history_max} versions. Deleting any versions older than that... # the results are sorted in descending order of the version creation time version_history=$(${aws} list-state-machine-versions --state- machine-arn ${sm_arn} --max-results 1000 --query "join(\`\"\\n\"\`, stateMachineVersions[].stateMachineVersionArn)" --output text) counter=0 while read line; do ((counter=${counter} + 1)) if [[ (( ${counter} -gt ${history_max})) ]]; then echo Deleting old version ${line} ${aws} delete-state-machine-version --state-machine-version-arn ${line} fi done <<< "${version_history}" echo Done! Use the AWS SDK to deploy a new state machine version The example script at aws-stepfunctions-examples shows how to use the AWS SDK for Python to gradually shift traﬃc from a previous version to a new version of a state machine. You can either use this example script or update it according to your requirements. The script shows the following deployment strategies: • Canary – Shifts traﬃc in two increments. In the ﬁrst increment, a small percentage of traﬃc, for example, 10 percent is shifted to the new version. In the second increment, before a speciﬁed time interval in seconds gets over, the remaining traﬃc is shifted to the new version. The switch to the new version for the remaining traﬃc takes place only if no CloudWatch alarms are set oﬀ during the speciﬁed time interval. • Linear or Rolling – Shifts traﬃc to the new version in equal increments with an equal number of seconds between each increment. Gradual deployment of versions 1004 AWS Step Functions Developer Guide For example, if you specify the increment percent as 20 with an --interval of 600 seconds, this deployment increases traﬃc by 20 percent every 600 seconds until the new version receives 100 percent of the traﬃc. This deployment immediately rolls back the new version if any CloudWatch alarms are set oﬀ. • All at Once or Blue/Green – Shifts 100 percent of traﬃc to the new version immediately. This deployment monitors the new version and rolls it back automatically to the previous version if any CloudWatch alarms are set oﬀ. Use AWS CloudFormation to deploy a new state machine version The following CloudFormation template example publishes two versions of a state machine named MyStateMachine. It creates an alias named PROD, which points to both these versions, and then deploys the version 2. In this example, 10 percent of traﬃc is shifted to the version 2 every ﬁve minutes until this version receives 100 percent of the traﬃc. This example also shows how you can set CloudWatch alarms. If any of the alarms you set go into the ALARM state, the deployment fails and rolls back immediately. MyStateMachine: Type: AWS::StepFunctions::StateMachine Properties: Type: STANDARD StateMachineName: MyStateMachine RoleArn: arn:aws:iam::account-id:role/myIamRole Definition: StartAt: PassState States: PassState: Type: Pass Result: Result End: true MyStateMachineVersionA: Type: AWS::StepFunctions::StateMachineVersion Properties: Description: Version 1 StateMachineArn: !Ref MyStateMachine MyStateMachineVersionB: Gradual deployment of versions 1005 AWS Step Functions Developer Guide Type: AWS::StepFunctions::StateMachineVersion Properties: Description: Version 2 StateMachineArn: !Ref MyStateMachine PROD: Type: AWS::StepFunctions::StateMachineAlias Properties: Name: PROD Description: The PROD state machine alias taking production traffic. DeploymentPreference: StateMachineVersionArn: !Ref MyStateMachineVersionB Type: LINEAR Percentage: 10 Interval: 5 Alarms: # A list of alarms that you want to monitor. If any of these alarms trigger, rollback the deployment immediately by pointing 100 percent of traffic to the previous version. - !Ref CloudWatchAlarm1 - !Ref CloudWatchAlarm2 Gradual deployment of versions 1006 AWS Step Functions Developer Guide Handling errors in Step Functions workﬂows All states, except Pass and Wait states, can encounter runtime errors. Errors can happen for various reasons, including the following: • State machine deﬁnition issues - such as a Choice state without a matching rule • Task failures - such as an exception in a AWS Lambda function • Transient issues - such as network partition events When a state reports an error, AWS Step Functions defaults to failing the entire state machine execution. Step Functions also has more advanced error handling features. You can set up your state machine to catch errors, retry failed states, and gracefully implement error handling protocols. Tip To deploy an example of a workﬂow that includes error handling, see Error Handling in The AWS Step Functions Workshop. Error names Step Functions identiﬁes errors in the Amazon States Language
step-functions-dg-275	step-functions-dg.pdf	275	rule • Task failures - such as an exception in a AWS Lambda function • Transient issues - such as network partition events When a state reports an error, AWS Step Functions defaults to failing the entire state machine execution. Step Functions also has more advanced error handling features. You can set up your state machine to catch errors, retry failed states, and gracefully implement error handling protocols. Tip To deploy an example of a workﬂow that includes error handling, see Error Handling in The AWS Step Functions Workshop. Error names Step Functions identiﬁes errors in the Amazon States Language using case-sensitive strings, known as error names. The Amazon States Language deﬁnes a set of built-in strings that name well- known errors, all beginning with the States. preﬁx. States.ALL A wildcard that matches any known error name. Note The States.ALL error type can't catch the States.DataLimitExceeded terminal error type and runtime error types. For more information about these error types, see States.DataLimitExceeded and States.Runtime. Error names 1007 AWS Step Functions Developer Guide States.DataLimitExceeded Reported due to the following conditions: • When the output of a connector is larger than payload size quota. • When the output of a state is larger than payload size quota. • When, after Parameters processing, the input of a state is larger than the payload size quota. For more information on quotas, see Step Functions service quotas. Note DataLimitExceeded is a terminal error which cannot be caught by the States.ALL error type. States.ExceedToleratedFailureThreshold A Map state failed because the number of failed items exceeded the threshold speciﬁed in the state machine deﬁnition. For more information, see Setting failure thresholds for Distributed Map states in Step Functions. States.HeartbeatTimeout A Task state failed to send a heartbeat for a period longer than the HeartbeatSeconds value. Note HeartbeatTimeout is only available inside the Catch and Retry ﬁelds. States.Http.Socket Occurs when an HTTP task times about after 60 seconds. See the section called “Quotas related to HTTP Task”. States.IntrinsicFailure Reserved for future use. Intrinsic functions processing errors are reported with the States.Runtime error name. Error names 1008 AWS Step Functions States.ItemReaderFailed Developer Guide A Map state failed because it couldn't read from the item source speciﬁed in the ItemReader ﬁeld. For more information, see ItemReader (Map). States.NoChoiceMatched Reserved for future use. If no choice is matched, the error is reported with the States.Runtime error name. States.ParameterPathFailure Reserved for future use. Parameter processing errors are reported with the States.Runtime error name. States.Permissions A Task state failed because it had insuﬃcient privileges to run the speciﬁed code. States.ResultPathMatchFailure Step Functions failed to apply a state's ResultPath ﬁeld to the input the state received. States.ResultWriterFailed A Map state failed because it couldn't write results to the destination speciﬁed in the ResultWriter ﬁeld. For more information, see ResultWriter (Map). States.Runtime An execution failed due to some exception that it couldn't process. Often these are caused by errors at runtime, such as attempting to apply InputPath or OutputPath on a null JSON payload. A States.Runtime error isn't retriable, and will always cause the execution to fail. A retry or catch on States.ALL won't catch States.Runtime errors. States.TaskFailed A Task state failed during the execution. When used in a retry or catch, States.TaskFailed acts as a wildcard that matches any known error name except for States.Timeout. States.Timeout A Task state either ran longer than the TimeoutSeconds value, or failed to send a heartbeat for a period longer than the HeartbeatSeconds value. Error names 1009 AWS Step Functions Developer Guide Additionally, if a state machine runs longer than the speciﬁed TimeoutSeconds value, the execution fails with a States.Timeout error. States can report errors with other names. However, these error names can't begin with the States. preﬁx. As a best practice, ensure production code can handle AWS Lambda service exceptions (Lambda.ServiceException and Lambda.SdkClientException). For more information, see Handle transient Lambda service exceptions. Note Unhandled errors in Lambda runtimes were historically reported only as Lambda.Unknown. In newer runtimes, timeouts are reported as Sandbox.Timedout in the error output. When Lambda exceeds the maximum number of invocations, the reported error will be Lambda.TooManyRequestsException. Match on Lambda.Unknown, Sandbox.Timedout, States.ALL, and States.TaskFailed to handle possible errors. For more information about Lambda Handled and Unhandled errors, see FunctionError in the AWS Lambda Developer Guide. Retrying after an error Task, Parallel, and Map states can have a ﬁeld named Retry, whose value must be an array of objects known as retriers. An individual retrier represents a certain number of retries, usually at increasing time intervals. When one of these states reports an error and there's a Retry ﬁeld, Step Functions scans through the retriers in the order listed in the array. When the error name appears in the value of a retrier's ErrorEquals ﬁeld, the state machine makes retry attempts as deﬁned in the
step-functions-dg-276	step-functions-dg.pdf	276	and Unhandled errors, see FunctionError in the AWS Lambda Developer Guide. Retrying after an error Task, Parallel, and Map states can have a ﬁeld named Retry, whose value must be an array of objects known as retriers. An individual retrier represents a certain number of retries, usually at increasing time intervals. When one of these states reports an error and there's a Retry ﬁeld, Step Functions scans through the retriers in the order listed in the array. When the error name appears in the value of a retrier's ErrorEquals ﬁeld, the state machine makes retry attempts as deﬁned in the Retry ﬁeld. If your redriven execution reruns a Task workﬂow state, Parallel workﬂow state, or Inline Map state, for which you have deﬁned retries, the retry attempt count for these states is reset to 0 to allow for the maximum number of attempts on redrive. For a redriven execution, you can track individual retry attempts of these states using the console. For more information, see Retry behavior of redriven executions in Restarting state machine executions with redrive in Step Functions. Retrying after an error 1010 AWS Step Functions Developer Guide A retrier contains the following ﬁelds: Note Retries are treated as state transitions. For information about how state transitions aﬀect billing, see Step Functions Pricing. ErrorEquals (Required) A non-empty array of strings that match error names. When a state reports an error, Step Functions scans through the retriers. When the error name appears in this array, it implements the retry policy described in this retrier. IntervalSeconds (Optional) A positive integer that represents the number of seconds before the ﬁrst retry attempt (1 by default). IntervalSeconds has a maximum value of 99999999. MaxAttempts (Optional) A positive integer that represents the maximum number of retry attempts (3 by default). If the error recurs more times than speciﬁed, retries cease and normal error handling resumes. A value of 0 speciﬁes that the error is never retried. MaxAttempts has a maximum value of 99999999. BackoffRate (Optional) The multiplier by which the retry interval denoted by IntervalSeconds increases after each retry attempt. By default, the BackoffRate value increases by 2.0. For example, say your IntervalSeconds is 3, MaxAttempts is 3, and BackoffRate is 2. The ﬁrst retry attempt takes place three seconds after the error occurs. The second retry takes place six seconds after the ﬁrst retry attempt. While the third retry takes place 12 seconds after the second retry attempt. MaxDelaySeconds (Optional) A positive integer that sets the maximum value, in seconds, up to which a retry interval can increase. This ﬁeld is helpful to use with the BackoffRate ﬁeld. The value you specify in this ﬁeld limits the exponential wait times resulting from the backoﬀ rate multiplier applied to each consecutive retry attempt. You must specify a value greater than 0 and less than 31622401 for MaxDelaySeconds. Retrying after an error 1011 AWS Step Functions Developer Guide If you don't specify this value, Step Functions doesn't limit the wait times between retry attempts. JitterStrategy (Optional) A string that determines whether or not to include jitter in the wait times between consecutive retry attempts. Jitter reduces simultaneous retry attempts by spreading these out over a randomized delay interval. This string accepts FULL or NONE as its values. The default value is NONE. For example, say you have set MaxAttempts as 3, IntervalSeconds as 2, and BackoffRate as 2. The ﬁrst retry attempt takes place two seconds after the error occurs. The second retry takes place four seconds after the ﬁrst retry attempt and the third retry takes place eight seconds after the second retry attempt. If you set JitterStrategy as FULL, the ﬁrst retry interval is randomized between 0 and 2 seconds, the second retry interval is randomized between 0 and 4 seconds, and the third retry interval is randomized between 0 and 8 seconds. Retry ﬁeld examples This section includes the following Retry ﬁeld examples. • Retry with BackoﬀRate • Retry with MaxDelaySeconds • Retry all errors except States.Timeout • Complex retry scenario Example 1 – Retry with BackoﬀRate The following example of a Retry makes two retry attempts with the ﬁrst retry taking place after waiting for three seconds. Based on the BackoffRate you specify, Step Functions increases the interval between each retry until the maximum number of retry attempts is reached. In the following example, the second retry attempt starts after waiting for three seconds after the ﬁrst retry. "Retry": [ { "ErrorEquals": [ "States.Timeout" ], "IntervalSeconds": 3, "MaxAttempts": 2, "BackoffRate": 1 Retry ﬁeld examples 1012 AWS Step Functions } ] Example 2 – Retry with MaxDelaySeconds Developer Guide The following example makes three retry attempts and limits the wait time resulting from BackoffRate at 5 seconds. The ﬁrst retry takes place after waiting for three seconds. The second and third
step-functions-dg-277	step-functions-dg.pdf	277	BackoffRate you specify, Step Functions increases the interval between each retry until the maximum number of retry attempts is reached. In the following example, the second retry attempt starts after waiting for three seconds after the ﬁrst retry. "Retry": [ { "ErrorEquals": [ "States.Timeout" ], "IntervalSeconds": 3, "MaxAttempts": 2, "BackoffRate": 1 Retry ﬁeld examples 1012 AWS Step Functions } ] Example 2 – Retry with MaxDelaySeconds Developer Guide The following example makes three retry attempts and limits the wait time resulting from BackoffRate at 5 seconds. The ﬁrst retry takes place after waiting for three seconds. The second and third retry attempts take place after waiting for ﬁve seconds after the preceding retry attempt because of the maximum wait time limit set by MaxDelaySeconds. "Retry": [ { "ErrorEquals": [ "States.Timeout" ], "IntervalSeconds": 3, "MaxAttempts": 3, "BackoffRate":2, "MaxDelaySeconds": 5, "JitterStrategy": "FULL" } ] Without MaxDelaySeconds, the second retry attempt would take place six seconds after the ﬁrst retry, and the third retry attempt would take place 12 seconds after the second retry. Example 3 – Retry all errors except States.Timeout The reserved name States.ALL that appears in a retrier's ErrorEquals ﬁeld is a wildcard that matches any error name. It must appear alone in the ErrorEquals array and must appear in the last retrier in the Retry array. The name States.TaskFailed also acts a wildcard and matches any error except for States.Timeout. The following example of a Retry ﬁeld retries any error except States.Timeout. "Retry": [ { "ErrorEquals": [ "States.Timeout" ], "MaxAttempts": 0 }, { "ErrorEquals": [ "States.ALL" ] } ] Example 4 – Complex retry scenario A retrier's parameters apply across all visits to the retrier in the context of a single-state execution. Consider the following Task state. Retry ﬁeld examples 1013 AWS Step Functions "X": { "Type": "Task", "Resource": "arn:aws:states:region:123456789012:task:X", "Next": "Y", "Retry": [ { "ErrorEquals": [ "ErrorA", "ErrorB" ], Developer Guide "IntervalSeconds": 1, "BackoffRate": 2.0, "MaxAttempts": 2 }, { "ErrorEquals": [ "ErrorC" ], "IntervalSeconds": 5 } ], "Catch": [ { "ErrorEquals": [ "States.ALL" ], "Next": "Z" } ] } This task fails four times in succession, outputting these error names: ErrorA, ErrorB, ErrorC, and ErrorB. The following occurs as a result: • The ﬁrst two errors match the ﬁrst retrier and cause waits of one and two seconds. • The third error matches the second retrier and causes a wait of ﬁve seconds. • The fourth error also matches the ﬁrst retrier. However, it already reached its maximum of two retries (MaxAttempts) for that particular error. Therefore, that retrier fails and the execution redirects the workﬂow to the Z state through the Catch ﬁeld. Fallback states Task, Map and Parallel states can each have a ﬁeld named Catch. This ﬁeld's value must be an array of objects, known as catchers. A catcher contains the following ﬁelds. ErrorEquals (Required) A non-empty array of strings that match error names, speciﬁed exactly as they are with the retrier ﬁeld of the same name. Fallback states 1014 AWS Step Functions Next (Required) Developer Guide A string that must exactly match one of the state machine's state names. ResultPath (Optional) A path that determines what input the catcher sends to the state speciﬁed in the Next ﬁeld. When a state reports an error and either there is no Retry ﬁeld, or if retries fail to resolve the error, Step Functions scans through the catchers in the order listed in the array. When the error name appears in the value of a catcher's ErrorEquals ﬁeld, the state machine transitions to the state named in the Next ﬁeld. The reserved name States.ALL that appears in a catcher's ErrorEquals ﬁeld is a wildcard that matches any error name. It must appear alone in the ErrorEquals array and must appear in the last catcher in the Catch array. The name States.TaskFailed also acts a wildcard and matches any error except for States.Timeout. The following example of a Catch ﬁeld transitions to the state named RecoveryState when a Lambda function outputs an unhandled Java exception. Otherwise, the ﬁeld transitions to the EndState state. "Catch": [ { "ErrorEquals": [ "java.lang.Exception" ], "ResultPath": "$.error-info", "Next": "RecoveryState" }, { "ErrorEquals": [ "States.ALL" ], "Next": "EndState" } ] Note Each catcher can specify multiple errors to handle. Fallback states 1015 AWS Step Functions Error output Developer Guide When Step Functions transitions to the state speciﬁed in a catch name, the object usually contains the ﬁeld Cause. This ﬁeld's value is a human-readable description of the error. This object is known as the error output. In this example, the ﬁrst catcher contains a ResultPath ﬁeld. This works similarly to a ResultPath ﬁeld in a state's top level, resulting in two possibilities: • It takes the results of that state's execution and overwrites either all of, or a portion of, the state's input. •
step-functions-dg-278	step-functions-dg.pdf	278	specify multiple errors to handle. Fallback states 1015 AWS Step Functions Error output Developer Guide When Step Functions transitions to the state speciﬁed in a catch name, the object usually contains the ﬁeld Cause. This ﬁeld's value is a human-readable description of the error. This object is known as the error output. In this example, the ﬁrst catcher contains a ResultPath ﬁeld. This works similarly to a ResultPath ﬁeld in a state's top level, resulting in two possibilities: • It takes the results of that state's execution and overwrites either all of, or a portion of, the state's input. • It takes the results and adds them to the input. In the case of an error handled by a catcher, the result of the state's execution is the error output. Thus, for the ﬁrst catcher in the example, the catcher adds the error output to the input as a ﬁeld named error-info if there isn't already a ﬁeld with this name in the input. Then, the catcher sends the entire input to RecoveryState. For the second catcher, the error output overwrites the input and the catcher only sends the error output to EndState. Note If you don't specify the ResultPath ﬁeld, it defaults to $, which selects and overwrites the entire input. When a state has both Retry and Catch ﬁelds, Step Functions uses any appropriate retriers ﬁrst. If the retry policy fails to resolve the error, Step Functions applies the matching catcher transition. Cause payloads and service integrations A catcher returns a string payload as an output. When working with service integrations such as Amazon Athena or AWS CodeBuild, you may want to convert the Cause string to JSON. The following example of a Pass state with intrinsic functions shows how to convert a Cause string to JSON. "Handle escaped JSON with JSONtoString": { "Type": "Pass", "Parameters": { Error output 1016 AWS Step Functions Developer Guide "Cause.$": "States.StringToJson($.Cause)" }, "Next": "Pass State with Pass Processing" }, State machine examples using Retry and using Catch The state machines deﬁned in the following examples assume the existence of two Lambda functions: one that always fails and one that waits long enough to allow a timeout deﬁned in the state machine to occur. This is a deﬁnition of a Node.js Lambda function that always fails, returning the message error. In the state machine examples that follow, this Lambda function is named FailFunction. For information about creating a Lambda function, see Step 1: Create a Lambda function section. exports.handler = (event, context, callback) => { callback("error"); }; This is a deﬁnition of a Node.js Lambda function that sleeps for 10 seconds. In the state machine examples that follow, this Lambda function is named sleep10. Note When you create this Lambda function in the Lambda console, remember to change the Timeout value in the Advanced settings section from 3 seconds (default) to 11 seconds. exports.handler = (event, context, callback) => { setTimeout(function(){ }, 11000); }; Handling a failure using Retry This state machine uses a Retry ﬁeld to retry a function that fails and outputs the error name HandledError. It retries this function twice with an exponential backoﬀ between retries. State machine examples using Retry and using Catch 1017 AWS Step Functions Developer Guide { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:FailFunction", "Retry": [ { "ErrorEquals": ["HandledError"], "IntervalSeconds": 1, "MaxAttempts": 2, "BackoffRate": 2.0 } ], "End": true } } } This variant uses the predeﬁned error code States.TaskFailed, which matches any error that a Lambda function outputs. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:FailFunction", "Retry": [ { "ErrorEquals": ["States.TaskFailed"], "IntervalSeconds": 1, "MaxAttempts": 2, "BackoffRate": 2.0 } ], "End": true } } } Handling a failure using Retry 1018 AWS Step Functions Note Developer Guide As a best practice, tasks that reference a Lambda function should handle Lambda service exceptions. For more information, see Handle transient Lambda service exceptions. Handling a failure using Catch This example uses a Catch ﬁeld. When a Lambda function outputs an error, it catches the error and the state machine transitions to the fallback state. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:FailFunction", "Catch": [ { "ErrorEquals": ["HandledError"], "Next": "fallback" } ], "End": true }, "fallback": { "Type": "Pass", "Result": "Hello, AWS Step Functions!", "End": true } } } This variant uses the predeﬁned error code States.TaskFailed, which matches any error that a Lambda function outputs. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States":
step-functions-dg-279	step-functions-dg.pdf	279	catches the error and the state machine transitions to the fallback state. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:FailFunction", "Catch": [ { "ErrorEquals": ["HandledError"], "Next": "fallback" } ], "End": true }, "fallback": { "Type": "Pass", "Result": "Hello, AWS Step Functions!", "End": true } } } This variant uses the predeﬁned error code States.TaskFailed, which matches any error that a Lambda function outputs. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { Handling a failure using Catch 1019 AWS Step Functions "HelloWorld": { Developer Guide "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:FailFunction", "Catch": [ { "ErrorEquals": ["States.TaskFailed"], "Next": "fallback" } ], "End": true }, "fallback": { "Type": "Pass", "Result": "Hello, AWS Step Functions!", "End": true } } } Handling a timeout using Retry This state machine uses a Retry ﬁeld to retry a Task state that times out, based on the timeout value speciﬁed in TimeoutSeconds. Step Functions retries the Lambda function invocation in this Task state twice, with an exponential backoﬀ between retries. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:sleep10", "TimeoutSeconds": 2, "Retry": [ { "ErrorEquals": ["States.Timeout"], "IntervalSeconds": 1, "MaxAttempts": 2, "BackoffRate": 2.0 } ], "End": true } } } Handling a timeout using Retry 1020 AWS Step Functions Developer Guide Handling a timeout using Catch This example uses a Catch ﬁeld. When a timeout occurs, the state machine transitions to the fallback state. { "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda function", "StartAt": "HelloWorld", "States": { "HelloWorld": { "Type": "Task", "Resource": "arn:aws:lambda:region:123456789012:function:sleep10", "TimeoutSeconds": 2, "Catch": [ { "ErrorEquals": ["States.Timeout"], "Next": "fallback" } ], "End": true }, "fallback": { "Type": "Pass", "Result": "Hello, AWS Step Functions!", "End": true } } } Note You can preserve the state input and the error by using ResultPath. See Use ResultPath to include both error and input in a Catch. Handling a timeout using Catch 1021 AWS Step Functions Developer Guide Troubleshooting issues in Step Functions If you encounter diﬃculties when working with Step Functions, use the following troubleshooting resources. The following topics provide troubleshooting advice for errors and issues that you might encounter related to Step Functions state machines, service integrations, activities, and workﬂows. If you ﬁnd an issue that is not listed here, you can use the Feedback button on this page to report it. For more troubleshooting advice and answers to common support questions, visit the AWS Knowledge Center. Topics • General troubleshooting • Troubleshooting service integrations • Troubleshooting activities • Troubleshooting express workﬂows General troubleshooting I'm unable to create a state machine. The IAM role associated with the state machine might not have suﬃcient permissions. Check the IAM role's permissions, including for AWS service integration tasks, X-Ray, and CloudWatch logging. Additional permissions are required for .sync task states. I'm unable to use a JsonPath to reference the previous task’s output. For a JsonPath, a JSON key must end with .$. This means a JsonPath can only be used in a key- value pair. If you want to use a JsonPath other places, such as an array, you can use intrinsic functions. For example, you could use something similar to the following: Task A output: { "sample": "test" } General issues 1022 AWS Step Functions Task B: Developer Guide { "JsonPathSample.$": "$.sample" } There was a delay in state transitions. For standard workﬂows, there is a limit on the number of state transitions. When you exceed the state transition limit, Step Functions delays state transitions until the bucket for the quota is ﬁlled. State transition limit throttling can be monitored by reviewing the ExecutionThrottled metric in the Execution metrics section of the CloudWatch Metrics page. When I start new Standard Workﬂow executions, they fail with the ExecutionLimitExceeded error. Step Functions has a limit of 1,000,000 open executions for each AWS account in each AWS Region. If you exceed this limit, Step Functions throws an ExecutionLimitExceeded error. This limit does not apply to Express Workﬂows. You can use the OpenExecutionCount to track when you are approaching the OpenExecutionLimit and create alarms to proactively notify you in that event. OpenExecutionCount is an approximate number of open workﬂows. For more information, see Execution metrics. A failure on one branch in a parallel state causes the whole execution to fail. This is an expected behavior. To avoid encountering failures when using a parallel state, conﬁgure Step Functions to catch errors thrown from each branch. Troubleshooting service integrations My job is complete in the downstream service, but in Step Functions the task state remains "In progress" or its completion is delayed. For .sync
step-functions-dg-280	step-functions-dg.pdf	280	OpenExecutionCount to track when you are approaching the OpenExecutionLimit and create alarms to proactively notify you in that event. OpenExecutionCount is an approximate number of open workﬂows. For more information, see Execution metrics. A failure on one branch in a parallel state causes the whole execution to fail. This is an expected behavior. To avoid encountering failures when using a parallel state, conﬁgure Step Functions to catch errors thrown from each branch. Troubleshooting service integrations My job is complete in the downstream service, but in Step Functions the task state remains "In progress" or its completion is delayed. For .sync service integration patterns, Step Functions uses EventBridge rules, downstream APIs, or a combination of both to detect the downstream job status. For some services, Step Functions There was a delay in state transitions. 1023 AWS Step Functions Developer Guide does not create EventBridge rules to monitor. For example, for the AWS Glue service integration, instead of using EventBridge rules, Step Functions makes a glue:GetJobRun call. Because of the frequency of API calls, there is a diﬀerence between the downstream task completion and the Step Functions task completion time. Step Functions requires IAM permissions to manage the EventBridge rules and to make calls to the downstream service. For more details about how insuﬃcient permissions on your execution role can aﬀect the completion of tasks, see Additional permissions for tasks using .sync. I want to return a JSON output from a nested state machine execution. There are two Step Functions synchronous service integrations for Step Functions: startExecution.sync and startExecution.sync:2. Both wait for the nested state machine to complete, but they return diﬀerent Output formats. You can use startExecution.sync:2 to return a JSON output under Output. I can't invoke a Lambda function from another account. Accessing the Lambda function with cross-account support If cross-account access of AWS resources is available in your Region, use the following method to invoke a Lambda function from another account. To invoke a cross-account resource in your workﬂows, do the following: 1. Create an IAM role in the target account that contains the resource. This role grants the source account, containing the state machine, permissions to access the target account's resources. 2. In the Task state's deﬁnition, specify the target IAM role to be assumed by the state machine before invoking the cross-account resource. 3. Modify the trust policy in the target IAM role to allow the source account to assume this role temporarily. The trust policy must include the Amazon Resource Name (ARN) of the state machine deﬁned in the source account. Also, deﬁne the appropriate permissions in the target IAM role to call the AWS resource. 4. Update the source account’s execution role to include the required permission for assuming the target IAM role. For an example, see Accessing cross-account AWS resources in Step Functions in the tutorials. I want to return a JSON output from a nested state machine execution. 1024 AWS Step Functions Note Developer Guide You can conﬁgure your state machine to assume an IAM role for accessing resources from multiple AWS accounts. However, a state machine can assume only one IAM role at a given time. For an example of a Task state deﬁnition that speciﬁes a cross-account resource, see Task state's Credentials ﬁeld examples. Accessing the Lambda function without cross-account support If cross-account access of AWS resources is unavailable in your Region, use the following method to invoke a Lambda function from another account. In the Task state’s Resource ﬁeld, use arn:aws:states:::lambda:invoke and pass the FunctionArn in parameters. The IAM role that is associated with the state machine must have the right permissions to invoke cross-account Lambda functions: lambda:invokeFunction. { "StartAt":"CallLambda", "States":{ "CallLambda":{ "Type":"Task", "Resource":"arn:aws:states:::lambda:invoke", "Parameters":{ "FunctionName":"arn:aws:lambda:region:account-id:function:my-function" }, "End":true } } } I'm unable to see task tokens passed from .waitForTaskToken states. In the Task state’s Parameters ﬁeld, you must pass a task token. For example, you could use something similar to the following code. { "StartAt":"taskToken", I'm unable to see task tokens passed from .waitForTaskToken states. 1025 AWS Step Functions "States":{ "taskToken":{ "Type":"Task", "Resource":"arn:aws:states:::lambda:invoke.waitForTaskToken", "Parameters":{ "FunctionName":"get-model-review-decision", "Payload":{ "token.$":"$$.Task.Token" Developer Guide }, }, "End":true } } } Note You can try to use .waitForTaskToken with any API action. However, some APIs don't have any suitable parameters. Troubleshooting activities My state machine execution is stuck at an activity state. An activity task state doesn't start until you poll a task token by using the GetActivityTask API action. As a best practice, add a task level timeout in order to avoid a stuck execution. For more information, see Using timeouts to avoid stuck Step Functions workﬂow executions. If your state machine is stuck in the ActivityScheduled event, it indicates that your activity worker ﬂeet has issues or is under-scaled. You should monitor the ActivityScheduleTime CloudWatch metric and set an alarm when that time
step-functions-dg-281	step-functions-dg.pdf	281	don't have any suitable parameters. Troubleshooting activities My state machine execution is stuck at an activity state. An activity task state doesn't start until you poll a task token by using the GetActivityTask API action. As a best practice, add a task level timeout in order to avoid a stuck execution. For more information, see Using timeouts to avoid stuck Step Functions workﬂow executions. If your state machine is stuck in the ActivityScheduled event, it indicates that your activity worker ﬂeet has issues or is under-scaled. You should monitor the ActivityScheduleTime CloudWatch metric and set an alarm when that time increases. However, to time out any stuck state machine executions in which the Activity state doesn't transition to the ActivityStarted state, deﬁne a timeout at state machine-level. To do this, specify a TimeoutSeconds ﬁeld at the beginning of the state machine deﬁnition, outside of the States ﬁeld. My activity worker times out while waiting for a task token. Workers use the GetActivityTask API action to retrieve a task with the speciﬁed activity ARN that is scheduled for execution by a running state machine. GetActivityTask starts a long poll, so Activities 1026 AWS Step Functions Developer Guide the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service hold the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. To avoid this timeout, conﬁgure a client side socket with a timeout of at least 65 seconds in the AWS SDK or in the client you are using to make the API call. Troubleshooting express workﬂows My application times out before receiving a response from a StartSyncExecution API call. Conﬁgure a client side socket timeout in the AWS SDK or client you use to make the API call. To receive a response, the timeout must have a value higher than the duration of the Express Workﬂow executions. I'm unable to see the execution history in order to troubleshoot Express Workﬂow failures. Express Workﬂows don't record execution history in AWS Step Functions. Instead, you must turn on CloudWatch logging. After logging is turned on, you can use CloudWatch Logs Insights queries to review your Express Workﬂow executions. You can also view execution history for Express Workﬂow executions on the Step Functions console if you choose the Enable button in the Executions tab. For more information, see Viewing execution details in the Step Functions console. To list executions based on duration: fields ispresent(execution_arn) as exec_arn \| filter exec_arn \| filter type in ["ExecutionStarted", "ExecutionSucceeded", "ExecutionFailed", "ExecutionAborted", "ExecutionTimedOut"] \| stats latest(type) as status, tomillis(earliest(event_timestamp)) as UTC_starttime, tomillis(latest(event_timestamp)) as UTC_endtime, latest(event_timestamp) - earliest(event_timestamp) as duration_in_ms by execution_arn \| sort duration_in_ms desc To list failed and cancelled executions: Express workﬂows 1027 AWS Step Functions Developer Guide fields ispresent(execution_arn) as isRes \| filter type in ["ExecutionFailed", "ExecutionAborted", "ExecutionTimedOut"] I'm unable to see the execution history in order to troubleshoot Express Workﬂow failures. 1028 AWS Step Functions Developer Guide Best practices for Step Functions Managing state and transforming data Learn about Passing data between states with variables and Transforming data with JSONata. The following topics are best practices to help you manage and optimize your Step Functions workﬂows. List of best practices • Optimizing costs using Express Workﬂows • Tagging state machines and activities in Step Functions • Using timeouts to avoid stuck Step Functions workﬂow executions • Using Amazon S3 ARNs instead of passing large payloads in Step Functions • Starting new executions to avoid reaching the history quota in Step Functions • Handle transient Lambda service exceptions • Avoiding latency when polling for activity tasks • CloudWatch Logs resource policy size limits Optimizing costs using Express Workﬂows Step Functions determines pricing for Standard and Express workﬂows based on the workﬂow type you use to build your state machines. To optimize the cost of your serverless workﬂows, you can follow either or both of the following recommendations: For information about how choosing a Standard or Express workﬂow type aﬀects billing, see AWS Step Functions Pricing. Nest Express workﬂows inside Standard workﬂows Step Functions runs workﬂows that have a ﬁnite duration and number of steps. Some workﬂows may complete execution within a short period of time. Others may require a combination of both Optimizing with Express Workﬂows 1029 AWS Step Functions Developer Guide long-running and high-event-rate workﬂows. With Step Functions, you can build large, complex workﬂows out of multiple smaller, simpler workﬂows. For example, to build an order processing workﬂow, you can include all non-idempotent actions into a Standard workﬂow. This could include actions, such as approving order through human interaction and processing payments. You can then combine a series of idempotent actions, such as sending payment notiﬁcations and updating product inventory, in an Express
step-functions-dg-282	step-functions-dg.pdf	282	Some workﬂows may complete execution within a short period of time. Others may require a combination of both Optimizing with Express Workﬂows 1029 AWS Step Functions Developer Guide long-running and high-event-rate workﬂows. With Step Functions, you can build large, complex workﬂows out of multiple smaller, simpler workﬂows. For example, to build an order processing workﬂow, you can include all non-idempotent actions into a Standard workﬂow. This could include actions, such as approving order through human interaction and processing payments. You can then combine a series of idempotent actions, such as sending payment notiﬁcations and updating product inventory, in an Express workﬂow. You can nest this Express workﬂow within the Standard workﬂow. In this example, the Standard workﬂow is known as the parent state machine. The nested Express workﬂow is known as a child state machine. Convert Standard workﬂows into Express workﬂows You can convert your existing Standard workﬂows into Express workﬂows if they meet the following requirements: • The workﬂow must complete its execution within ﬁve minutes. • The workﬂow conforms to an at-least-once execution model. This means that each step in the workﬂow may run more than exactly once. • The workﬂow doesn't use the .waitForTaskToken or .sync service integration patterns. Important Express workﬂows use Amazon CloudWatch Logs to record execution histories. You will incur additional costs when using CloudWatch Logs. To convert a Standard workﬂow into an Express workﬂow using the console 1. Open the Step Functions console. 2. On the State machines page, choose a Standard type state machine to open it. Tip From the Any type dropdown list, choose Standard to ﬁlter the state machines list and view only Standard workﬂows. 3. Choose Copy to new. Convert to Express workﬂow type 1030 AWS Step Functions Developer Guide Workﬂow Studio opens in Design mode displaying workﬂow of the state machine you 4. 5. 6. selected. (Optional) Update the workﬂow design. Specify a name for your state machine. To do this, choose the edit icon next to the default state machine name of MyStateMachine. Then, in State machine conﬁguration, specify a name in the State machine name box. (Optional) In State machine conﬁguration, specify other workﬂow settings, such as state machine type and its execution role. Make sure that for Type, you choose Express. Keep all the other default selections on State machine settings. Note If you're converting a Standard workﬂow previously deﬁned in AWS CDK or AWS SAM, you must change the value of Type and Resource name. 7. In the Conﬁrm role creation dialog box, choose Conﬁrm to continue. You can also choose View role settings to go back to State machine conﬁguration. Note If you delete the IAM role that Step Functions creates, Step Functions can't recreate it later. Similarly, if you modify the role (for example, by removing Step Functions from the principals in the IAM policy), Step Functions can't restore its original settings later. For more information about best practices and guidelines when you manage cost-optimization for your workﬂows, see Building cost-eﬀective AWS Step Functions workﬂows. Tagging state machines and activities in Step Functions AWS Step Functions supports tagging state machines (both Standard and Express) and activities. Tags can help you track and manage your resources and provide better security in your AWS Identity and Access Management (IAM) policies. After tagging Step Functions resources, you can manage them with AWS Resource Groups. To learn how, see the AWS Resource Groups User Guide. Tagging resources 1031 AWS Step Functions Developer Guide For tag-based authorization, state machine execution resources as shown in the following example inherit the tags associated with a state machine. arn:partition:states:region:account-id:execution:<StateMachineName>:<ExecutionId> When you call DescribeExecution or other APIs in which you specify the execution resource ARN, Step Functions uses tags associated with the state machine to accept or deny the request while performing tag-based authorization. This helps you allow or deny access to state machine executions at the state machine level. To review the restrictions related to resource tagging, see Restrictions related to tagging. Tagging for Cost Allocation You can use cost allocation tags to identify the purpose of a state machine and reﬂect that organization in your AWS bill. Sign up to get your AWS account bill to include the tag keys and values. See Setting Up a Monthly Cost Allocation Report in the AWS Billing User Guide for details on setting up reports. For example, you could add tags that represent your cost center and purpose of your Step Functions resources, as follows. Resource Key StateMachine1 Cost Center Value 34567 Application Image processing Cost Center 34567 StateMachine2 Application Rekognition processin g Tagging for Security IAM supports controlling access to resources based on tags. To control access based on tags, provide information about your resource tags in the condition element of an IAM policy. Tagging for Cost Allocation 1032 AWS Step
step-functions-dg-283	step-functions-dg.pdf	283	keys and values. See Setting Up a Monthly Cost Allocation Report in the AWS Billing User Guide for details on setting up reports. For example, you could add tags that represent your cost center and purpose of your Step Functions resources, as follows. Resource Key StateMachine1 Cost Center Value 34567 Application Image processing Cost Center 34567 StateMachine2 Application Rekognition processin g Tagging for Security IAM supports controlling access to resources based on tags. To control access based on tags, provide information about your resource tags in the condition element of an IAM policy. Tagging for Cost Allocation 1032 AWS Step Functions Developer Guide For example, you could restrict access to all Step Functions resources that include a tag with the key environment and the value production. { "Version": "2012-10-17", "Statement": [ { "Effect": "Deny", "Action": [ "states:TagResource", "states:DeleteActivity", "states:DeleteStateMachine", "states:StopExecution" ], "Resource": "*", "Condition": { "StringEquals": {"aws:ResourceTag/environment": "production"} } } ] } For more information, see Controlling Access Using Tags in the IAM User Guide. Managing tags in the Step Functions console You can view and manage tags for your state machines in the Step Functions console. From the Details page of a state machine, select Tags. Managing tags with Step Functions API Actions To manage tags using the Step Functions API, use the following API actions: • ListTagsForResource • TagResource • UntagResource Managing tags in the Step Functions console 1033 AWS Step Functions Developer Guide Using timeouts to avoid stuck Step Functions workﬂow executions By default, the Amazon States Language doesn't specify timeouts for state machine deﬁnitions. Without an explicit timeout, Step Functions often relies solely on a response from an activity worker to know that a task is complete. If something goes wrong and the TimeoutSeconds ﬁeld isn't speciﬁed for an Activity or Task state, an execution is stuck waiting for a response that will never come. To avoid this situation, specify a reasonable timeout when you create a Task in your state machine. For example: "ActivityState": { "Type": "Task", "Resource": "arn:aws:states:region:account-id:activity:HelloWorld", "TimeoutSeconds": 300, "Next": "NextState" } If you use a callback with a task token (.waitForTaskToken), we recommend that you use heartbeats and add the HeartbeatSeconds ﬁeld in your Task state deﬁnition. You can set HeartbeatSeconds to be less than the task timeout so if your workﬂow fails with a heartbeat error then you know it's because of the task failure instead of the task taking a long time to complete. { "StartAt": "Push to SQS", "States": { "Push to SQS": { "Type": "Task", "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken", "HeartbeatSeconds": 600, "Parameters": { "MessageBody": { "myTaskToken.$": "$$.Task.Token" }, "QueueUrl": "https://sqs.us-east-1.amazonaws.com/account-id/push-based-queue" }, "ResultPath": "$.SQS", "End": true } } Using timeouts to avoid stuck executions 1034 AWS Step Functions } Developer Guide For more information, see Task workﬂow state in the Amazon States Language documentation. Note You can set a timeout for your state machine using the TimeoutSeconds ﬁeld in your Amazon States Language deﬁnition. For more information, see State machine structure in Amazon States Language for Step Functions workﬂows. Using Amazon S3 ARNs instead of passing large payloads in Step Functions Executions that pass large payloads of data between states can be terminated. If the data you are passing between states might grow to over 256 KiB, use Amazon Simple Storage Service (Amazon S3) to store the data, and parse the Amazon Resource Name (ARN) of the bucket in the Payload parameter to get the bucket name and key value. Alternatively, adjust your implementation so that you pass smaller payloads in your executions. In the following example, a state machine passes input to an AWS Lambda function, which processes a JSON ﬁle in an Amazon S3 bucket. After you run this state machine, the Lambda function reads the contents of the JSON ﬁle, and returns the ﬁle contents as output. Create the Lambda function The following Lambda function named pass-large-payload reads the contents of a JSON ﬁle stored in a speciﬁc Amazon S3 bucket. Note After you create this Lambda function, make sure you provide its IAM role the appropriate permission to read from an Amazon S3 bucket. For example, attach the AmazonS3ReadOnlyAccess permission to the Lambda function's role. import json Using Amazon S3 to pass large data 1035 Developer Guide AWS Step Functions import boto3 import io import os s3 = boto3.client('s3') def lambda_handler(event, context): event = event['Input'] final_json = str() s3 = boto3.resource('s3') bucket = event['bucket'].split(':')[-1] filename = event['key'] directory = "/tmp/{}".format(filename) s3.Bucket(bucket).download_file(filename, directory) with open(directory, "r") as jsonfile: final_json = json.load(jsonfile) os.popen("rm -rf /tmp") return final_json Create the state machine The following state machine invokes the Lambda function you previously created. { "StartAt":"Invoke Lambda function", "States":{ "Invoke Lambda function":{ "Type":"Task", "Resource":"arn:aws:states:::lambda:invoke", "Parameters":{ "FunctionName":"arn:aws:lambda:us-east-2:123456789012:function:pass-large- payload", "Payload":{ "Input.$":"$" } }, "OutputPath": "$.Payload", "End":true Using Amazon S3 to pass large data 1036 AWS Step Functions } } } Developer Guide Rather
step-functions-dg-284	step-functions-dg.pdf	284	AWS Step Functions import boto3 import io import os s3 = boto3.client('s3') def lambda_handler(event, context): event = event['Input'] final_json = str() s3 = boto3.resource('s3') bucket = event['bucket'].split(':')[-1] filename = event['key'] directory = "/tmp/{}".format(filename) s3.Bucket(bucket).download_file(filename, directory) with open(directory, "r") as jsonfile: final_json = json.load(jsonfile) os.popen("rm -rf /tmp") return final_json Create the state machine The following state machine invokes the Lambda function you previously created. { "StartAt":"Invoke Lambda function", "States":{ "Invoke Lambda function":{ "Type":"Task", "Resource":"arn:aws:states:::lambda:invoke", "Parameters":{ "FunctionName":"arn:aws:lambda:us-east-2:123456789012:function:pass-large- payload", "Payload":{ "Input.$":"$" } }, "OutputPath": "$.Payload", "End":true Using Amazon S3 to pass large data 1036 AWS Step Functions } } } Developer Guide Rather than pass a large amount of data in the input, you could save that data in an Amazon S3 bucket, and pass the Amazon Resource Name (ARN) of the bucket in the Payload parameter to get the bucket name and key value. Your Lambda function can then use that ARN to access the data directly. The following is example input for the state machine execution, where the data is stored in data.json in an Amazon S3 bucket named amzn-s3-demo-large-payload-json. { "key": "data.json", "bucket": "arn:aws:s3:::amzn-s3-demo-large-payload-json" } Starting new executions to avoid reaching the history quota in Step Functions AWS Step Functions has a hard quota of 25,000 entries in the execution event history. When an execution reaches 24,999 events, it waits for the next event to happen. • If the event number 25,000 is ExecutionSucceeded, the execution ﬁnishes successfully. • If the event number 25,000 isn't ExecutionSucceeded, the ExecutionFailed event is logged and the state machine execution fails because of reaching the history limit To avoid reaching this quota for long-running executions, you can try one of the following workarounds: • Use the Map state in Distributed mode. In this mode, the Map state runs each iteration as a child workﬂow execution, which enables high concurrency of up to 10,000 parallel child workﬂow executions. Each child workﬂow execution has its own, separate execution history from that of the parent workﬂow. • Start a new state machine execution directly from the Task state of a running execution. To start such nested workﬂow executions, use Step Functions' StartExecution API action in the parent state machine along with the necessary parameters. For more information about using nested workﬂows, see Start workﬂow executions from a task state in Step Functions or Using a Step Functions API action to continue a new execution tutorial. Avoiding execution history quota 1037 AWS Step Functions Tip Developer Guide To deploy an example nested workﬂow, see Optimizing costs in The AWS Step Functions Workshop. • Implement a pattern that uses an AWS Lambda function that can start a new execution of your state machine to split ongoing work across multiple workﬂow executions. For more information, see the Using a Lambda function to continue a new execution in Step Functions tutorial. Handle transient Lambda service exceptions AWS Lambda can occasionally experience transient service errors. In this case, invoking Lambda results in a 500 error, such as ClientExecutionTimeoutException, ServiceException, AWSLambdaException, or SdkClientException. As a best practice, proactively handle these exceptions in your state machine to Retry invoking your Lambda function, or to Catch the error. Lambda errors are reported as Lambda.ErrorName. To retry a Lambda service exception error, you could use the following Retry code. "Retry": [ { "ErrorEquals": [ "Lambda.ClientExecutionTimeoutException", "Lambda.ServiceException", "Lambda.AWSLambdaException", "Lambda.SdkClientException"], "IntervalSeconds": 2, "MaxAttempts": 6, "BackoffRate": 2 } ] Note Unhandled errors in Lambda runtimes were historically reported only as Lambda.Unknown. In newer runtimes, timeouts are reported as Sandbox.Timedout in the error output. When Lambda exceeds the maximum number of invocations, the reported error will be Lambda.TooManyRequestsException. Match on Lambda.Unknown, Sandbox.Timedout, States.ALL, and States.TaskFailed to handle possible errors. For more information about Lambda Handled and Unhandled errors, see FunctionError in the AWS Lambda Developer Guide. Handling Lambda exceptions 1038 AWS Step Functions Developer Guide For more information, see the following: • Retrying after an error • Handling error conditions using a Step Functions state machine • Lambda Invoke Errors Avoiding latency when polling for activity tasks The GetActivityTask API is designed to provide a taskToken exactly once. If a taskToken is dropped while communicating with an activity worker, a number of GetActivityTask requests can be blocked for 60 seconds waiting for a response until GetActivityTask times out. If you only have a small number of polls waiting for a response, it's possible that all requests will queue up behind the blocked request and stop. However, if you have a large number of outstanding polls for each activity Amazon Resource Name (ARN), and some percentage of your requests are stuck waiting, there will be many more that can still get a taskToken and begin to process work. For production systems, we recommend at least 100 open polls per activity ARN's at each point in time. If one poll gets blocked,
step-functions-dg-285	step-functions-dg.pdf	285	waiting for a response until GetActivityTask times out. If you only have a small number of polls waiting for a response, it's possible that all requests will queue up behind the blocked request and stop. However, if you have a large number of outstanding polls for each activity Amazon Resource Name (ARN), and some percentage of your requests are stuck waiting, there will be many more that can still get a taskToken and begin to process work. For production systems, we recommend at least 100 open polls per activity ARN's at each point in time. If one poll gets blocked, and a portion of those polls queue up behind it, there are still many more requests that will receive a taskToken to process work while the GetActivityTask request is blocked. To avoid these kinds of latency problems when polling for tasks: • Implement your pollers as separate threads from the work in your activity worker implementation. • Have at least 100 open polls per activity ARN at each point in time. Note Scaling to 100 open polls per ARN can be expensive. For example, 100 Lambda functions polling per ARN is 100 times more expensive than having a single Lambda function with 100 polling threads. To both reduce latency and minimize cost, use a language that has asynchronous I/O, and implement multiple polling threads per worker. For an example activity worker where the poller threads are separate from the work threads, see Example: Activity Worker in Ruby. Avoiding latency for activity task tasks 1039 AWS Step Functions Developer Guide For more information on activities and activity workers see Learn about Activities in Step Functions. CloudWatch Logs resource policy size limits When you create a state machine with logging, or update an existing state machine to enable logging, Step Functions must update your CloudWatch Logs resource policy with the log group that you specify. CloudWatch Logs resource policies are limited to 5,120 characters. When CloudWatch Logs detects that a policy approaches the size limit, CloudWatch Logs automatically enables logging for log groups that start with /aws/vendedlogs/. You can preﬁx your CloudWatch Logs log group names with /aws/vendedlogs/ to avoid the CloudWatch Logs resource policy size limit. If you create a log group in the Step Functions console, the suggested log group name will already be preﬁxed with /aws/vendedlogs/states. CloudWatch Logs also has a quota of 10 resource policies per region, per account. If you try to enable logging on a state machine that already has 10 CloudWatch Logs resource policies in a region for an account, the state machine will not be created or updated. For more information about logging quotes, see CloudWatch Logs quotas. If you are having trouble sending logs to CloudWatch Logs, see Troubleshooting state machine logging to CloudWatch Logs. To learn more about logging in general, see Enable logging from AWS services. Log resource policy limits 1040 AWS Step Functions Developer Guide Step Functions service quotas AWS Step Functions provide default service quotas for state machine parameters, such as the number of API actions during a time period or the number of state machines that you can deﬁne. Quotas are designed to prevent misconﬁgured state machine from consuming all of the resources of the system, although many do not have hard limits. To request a service quota increase, you can do one of the following: • Use the Service Quotas console at https://console.aws.amazon.com/servicequotas/home. For information about requesting a quota increase using the Service Quotas console, see Requesting a quota increase in the Service Quotas User Guide. • Use the Support Center page in the AWS Management Console to request a quota increase for resources provided by AWS Step Functions on a per-Region basis. For more information, see AWS service quotas in the AWS General Reference. Note If a particular stage of your state machine execution or activity execution takes too long, you can conﬁgure a state machine timeout to cause a timeout event. Topics • General quotas • Quotas related to accounts • Quotas related to HTTP Task • Quotas related to state throttling • Quotas related to API action throttling • Quotas related to state machine executions • Quotas related to task executions • Quotas related to versions and aliases • Restrictions related to tagging 1041 AWS Step Functions General quotas Developer Guide Names of state machines, executions, and activity tasks must not exceed 80 characters in length. These names must be unique for your account and AWS Region, and must not contain any of the following: • Whitespace • Wildcard characters (? *) • Bracket characters (< > { } [ ]) • Special characters (" # % \ ^ \| ~ ` $ & , ; : /) • Control characters (\\u0000 - \\u001f or \\u007f - \\u009f). Step Functions accepts names for state
step-functions-dg-286	step-functions-dg.pdf	286	to versions and aliases • Restrictions related to tagging 1041 AWS Step Functions General quotas Developer Guide Names of state machines, executions, and activity tasks must not exceed 80 characters in length. These names must be unique for your account and AWS Region, and must not contain any of the following: • Whitespace • Wildcard characters (? *) • Bracket characters (< > { } [ ]) • Special characters (" # % \ ^ \| ~ ` $ & , ; : /) • Control characters (\\u0000 - \\u001f or \\u007f - \\u009f). Step Functions accepts names for state machines, executions, activities, and labels that contain non-ASCII characters. Because such characters will not work with Amazon CloudWatch, we recommend using only ASCII characters so you can track metrics in CloudWatch. Quotas related to accounts Resource Default quota Can be increased to Maximum number of registered state machines Maximum number of registered activities Maximum size of state machine deﬁnition Maximum request size 100,000 150,000 100,000 150,000 1 MB Hard quota Hard quota 1 MB per request. This is the total data size per Step Functions API request, including the request header and all other associated request data. General quotas 1042 AWS Step Functions Resource Default quota Can be increased to Maximum open executions per account 1,000,000 executions for each AWS account in each AWS Developer Guide Millions Region. Exceeding this limit will cause an Execution error. LimitExceeded This doesn't apply to Express Workﬂows. Maximum number of open Map Runs 1000 Hard quota This quota applies to Distribut ed Map state. An open Map Run is a Map Run that has started, but hasn't yet completed. Scheduled Map Runs wait at the MapRunStarted event until the total number of open Map Runs is less than the quota. Maximum redrives of a Map Run. 1000 Hard quota This quota applies to Distribut ed Map state. Maximum number of parallel Map Run child executions 10,000 Hard quota Quotas related to HTTP Task HTTP Tasks are throttled using a token bucket scheme to maintain the Step Functions service bandwidth. Quotas related to HTTP Task 1043 AWS Step Functions Resource HTTP Task Developer Guide Bucket size Reﬁll rate per second 300 300 Resource Default quota HTTP Task duration — time to send an HTTP request and receive a response 60 seconds (Hard quota) Quotas related to state throttling Step Functions state transitions are throttled using a token bucket scheme to maintain service bandwidth. Standard Workﬂows and Express Workﬂows have diﬀerent state transition throttling. Standard Workﬂows quotas are soft quotas and can be increased. Note Throttling on the StateTransition service metric is reported as ExecutionThrottled in Amazon CloudWatch. For more information, see the ExecutionThrottled CloudWatch metric. Standard Service metric Bucket size Reﬁll rate per second Express Bucket size Reﬁll rate per second 5,000 5,000 Unlimited Unlimited StateTran sition — US East (N. Virginia), US West (Oregon), and Europe (Ireland) Quotas related to state throttling 1044 AWS Step Functions Developer Guide Standard Service metric Bucket size Reﬁll rate per second Express Bucket size Reﬁll rate per second 800 800 Unlimited Unlimited StateTran sition — All other regions Quotas related to API action throttling Some Step Functions API actions are throttled using a token bucket scheme to maintain service bandwidth. The following are soft quotas and can be increased. Note Throttling quotas are per account, per AWS Region. AWS Step Functions may increase both the bucket size and reﬁll rate at any time. Standard API name Bucket size Reﬁll rate per second Express Bucket size Reﬁll rate per second 1,300 300 6,000 6,000 800 150 6,000 6,000 StartExec ution — US East (N. Virginia), US West (Oregon), and Europe (Ireland) StartExec ution — All other regions Quotas related to API action throttling 1045 AWS Step Functions Developer Guide Quota related to TestState API API name TestState Other quotas Quota Can be increased to 1 transaction per second (TPS) Hard quota The following are soft quotas and can be increased. US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second CreateAct 100 ivity CreateSta 100 teMachine CreateSta teMachine Alias 100 DeleteAct 100 ivity DeleteSta 100 teMachine DeleteSta teMachine Alias 100 1 1 1 1 1 1 100 100 100 100 100 100 1 1 1 1 1 1 Quota related to TestState API 1046 AWS Step Functions Developer Guide US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second 100 DeleteSta teMachine Version DescribeA 200 ctivity DescribeE 300 xecution DescribeM 200 apRun DescribeS tateMachi ne DescribeS tateMachi neAlias DescribeS tateMachi neForExec ution 200 200 200 GetActivi 3,000 tyTask GetExecut ionHistory 400 1 1 15 1
step-functions-dg-287	step-functions-dg.pdf	287	ivity DeleteSta 100 teMachine DeleteSta teMachine Alias 100 1 1 1 1 1 1 100 100 100 100 100 100 1 1 1 1 1 1 Quota related to TestState API 1046 AWS Step Functions Developer Guide US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second 100 DeleteSta teMachine Version DescribeA 200 ctivity DescribeE 300 xecution DescribeM 200 apRun DescribeS tateMachi ne DescribeS tateMachi neAlias DescribeS tateMachi neForExec ution 200 200 200 GetActivi 3,000 tyTask GetExecut ionHistory 400 1 1 15 1 20 1 1 500 20 100 200 250 200 200 200 200 1,500 400 1 1 10 1 20 1 1 300 20 Other quotas 1047 AWS Step Functions Developer Guide US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second ListActiv 100 10 ities ListExecu 200 tions 100 100 ListMapRuns ListState MachineAl iases ListState 100 Machines ListState MachineVe rsions ListTagsF orResource PublishSt ateMachin eVersion 100 100 100 RedriveEx 1,300 ecution SendTaskF 3,000 ailure 5 1 1 5 1 1 1 300 500 100 100 100 100 100 100 100 100 800 1,500 5 2 1 1 5 1 1 1 150 300 Other quotas 1048 AWS Step Functions Developer Guide US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second SendTaskH 3,000 eartbeat SendTaskS 3,000 500 500 1,500 1,500 300 300 uccess StartSync Execution Synchronous Express execution API calls don't contribute to existing account capacity limits. Step Functions provides capacity on demand and automatic ally scales with sustained workload. Surges in workload may be throttled until capacity is available. If you experience throttling, try again after some time. For information about Synchronous Express workﬂows, see Synchronous and Asynchronous Express Workﬂows in Step Functions. StopExecu 1,000 200 tion TagResource UntagReso urce 200 200 UpdateMap 100 Run UpdateSta 100 teMachine UpdateSta teMachine Alias 100 1 1 1 1 1 500 200 200 100 100 100 25 1 1 1 1 1 Other quotas 1049 AWS Step Functions Developer Guide US East (N. Virginia), US West (Oregon), and Europe (Ireland) All other regions API name Bucket size Reﬁll rate per second Bucket size Reﬁll rate per second 100 1 100 1 ValidateS tateMachi neDefinit ion Quotas related to state machine executions The following table describes quotas related to state machine executions. State machine execution quotas are hard quotas that can't be changed, except for the Execution history retention time quota. Quota Standard Express Maximum execution time Maximum execution history size 1 year. If an execution runs for more than the 1-year 5 minutes. If an execution runs for more than the 5- maximum, it will fail with minute maximum, it will fail a States.Timeout error and emit a Execution sTimedOut CloudWatch metric. with a States.Timeout error and emit a Execution sTimedOut CloudWatch metric. Unlimited. 25,000 events in a single state machine execution history. If the execution history reaches this quota, the execution will fail. To avoid this, see Starting new executions to avoid reaching the history quota in Step Functions. Maximum execution idle time 1 year 5 minutes Quotas related to state machine executions 1050 AWS Step Functions Developer Guide Quota Standard Express Constrained by maximum Constrained by maximum execution time. execution time. Execution history retention time 90 days after an execution is closed. After this time, you To see execution history, Amazon CloudWatch Logs can no longer retrieve or view logging must be conﬁgure the execution history. There d. For more information, see is no further quota for the Using CloudWatch Logs to number of closed executions log execution history in Step that Step Functions retains. Functions. To meet compliance, organizational, or regulator y requirements, you can reduce the execution history retention period to 30 days by sending a quota request. To do this, use the AWS Support Center Console and create a new case. The change to reduce the retention period to 30 days is applicable for each account in a Region. Quotas related to state machine executions 1051 AWS Step Functions Developer Guide Quota Standard Express Execution redrivable period 14 days Redrive is not supported for Express workﬂows. Hard quota applies to Distributed Map state. Redrivable period refers to the time during which you can redrive a given Standard Workﬂow execution. This period starts from the day a state machine completes its execution. Quotas related to task executions The following table describes quotas related to task executions. These are all hard quotas that cannot be changed. Quota Standard Express Maximum task execution time 1 year — Constrained by maximum execution time. 5 minutes — Constrained
step-functions-dg-288	step-functions-dg.pdf	288	machine executions 1051 AWS Step Functions Developer Guide Quota Standard Express Execution redrivable period 14 days Redrive is not supported for Express workﬂows. Hard quota applies to Distributed Map state. Redrivable period refers to the time during which you can redrive a given Standard Workﬂow execution. This period starts from the day a state machine completes its execution. Quotas related to task executions The following table describes quotas related to task executions. These are all hard quotas that cannot be changed. Quota Standard Express Maximum task execution time 1 year — Constrained by maximum execution time. 5 minutes — Constrained by maximum execution time. Maximum time Step Functions keeps a task in the 1 year — Constrained by maximum execution time. 5 minutes — Constrained by maximum execution time. queue Maximum activity pollers per Amazon Resource Name (ARN) Does not apply to Express Workﬂows. 1,000 pollers calling GetActivityTask per ARN. Exceeding this quota results in this error: "The maximum number of workers concurrently polling for activity tasks has been reached." Quotas related to task executions 1052 AWS Step Functions Developer Guide Quota Standard Express Maximum input or output size for a task, state, or execution 256 KiB of data as a UTF-8 encoded string. This quota 256 KiB of data as a UTF-8 encoded string. This quota aﬀects tasks (activity, Lambda aﬀects tasks (activity, Lambda function, or integrated function, or integrated service), state or execution service), state or execution output, and input data when output, and input data when scheduling a task, entering a scheduling a task, entering a state, or starting an execution state, or starting an execution . . Quotas related to versions and aliases Resource Default quota Maximum number of published state machine 1000 per state machine versions Maximum number of state machine aliases 100 per state machine To request an increase to soft limits for published state machine versions and aliases, use the Support Center page in the AWS Management Console. Restrictions related to tagging The following tagging restrictions can not be modiﬁed or increased. • Preﬁx restriction — Do not use the aws: preﬁx in your tag names or values because it is reserved for AWS use only. You cannot edit or delete tag names or values with an aws: preﬁx. Tags with the aws: preﬁx do not count against your tags per resource quota. • Character restrictions — Tags may only contain Unicode letters, digits, whitespace, or the following symbols: _ . : / = + - @ Quotas related to versions and aliases 1053 AWS Step Functions Restriction Developer Guide Description Maximum number of tags per resource 50 Maximum key length Maximum value length 128 Unicode characters in UTF-8 256 Unicode characters in UTF-8 Restrictions related to tagging 1054 AWS Step Functions Developer Guide Recent feature launches The following table lists dates and links to announcements for recent Step Functions feature releases: Launch date Feature description 2025-02-07 2024-11-22 2024-11-14 2024-06-25 AWS Step Functions expands data source and output options for Distribut ed Map. Simplifying developer experience with variables and JSONata in AWS Step Functions IaC exports to AWS SAM templates, CloudFormation templates, and to Infrastructure Composer. Encrypt workﬂows, logs, and activities with AWS KMS customer managed keys. 2023-11-26 Invoke HTTPS endpoints and test states with TestState API. 2023-11-15 Restarting state machine executions with redrive in Step Functions 2023-10-12 Add optimized integration for Amazon EMR Serverless 2023-09-07 Enhance error handling 2023-08-31 Workﬂow Studio enhancements to streamline the authoring experience 2023-06-22 Versions and aliases 2023-06-16 Add seven AWS SDK integrations, including VPC Lattice 2022-12-01 Orchestrate large-scale parallel workﬂows for data processing with Distributed Map state 1055 AWS Step Functions Developer Guide Document history This section lists major changes to the AWS Step Functions Developer Guide. Change Description Date changed Updates Step Functions will now auto-create roles and policy for optimized integrations with MediaConvert. March 14, 2025 For integrations with MediaConvert, Step Functions will now automatically create the necessary roles and policies required by your state machine. To learn more, see the section called “AWS Elemental MediaConvert” and Integrating optimized services. New feature Step Functions expands data source and output options for Distributed Map. February 7, 2025 Distributed map can process data from JSON Lines (JSONL) and a broader range of delimited ﬁle formats, such as semicolon-delimited ﬁles and tab-delimited ﬁles. Additionally, Distributed Map oﬀers output transform ations for greater control over result formatting. To learn more, ItemReader (Map) and ResultWriter (Map). Documentation-only update Replaced the Getting started tutorial with content from workshop presented at re:Invent 2024. Dec 23, 2024 New feature Manage state and transform data with Step Functions workﬂow variables and JSONata. November 22, 2024 With variables, you can pass data between the steps of your workﬂows. With JSONata, you gain an open source query and expression language to select and transform data in
step-functions-dg-289	step-functions-dg.pdf	289	and a broader range of delimited ﬁle formats, such as semicolon-delimited ﬁles and tab-delimited ﬁles. Additionally, Distributed Map oﬀers output transform ations for greater control over result formatting. To learn more, ItemReader (Map) and ResultWriter (Map). Documentation-only update Replaced the Getting started tutorial with content from workshop presented at re:Invent 2024. Dec 23, 2024 New feature Manage state and transform data with Step Functions workﬂow variables and JSONata. November 22, 2024 With variables, you can pass data between the steps of your workﬂows. With JSONata, you gain an open source query and expression language to select and transform data in your workﬂows. To learn more, see Passing data between states with variables and Transforming data with JSONata in Step Functions. 1056 AWS Step Functions Change Description Developer Guide Date changed New feature Step Functions adds Infrastructure as Code (IaC) template generation November 14, 2024 The AWS Step Functions console provides the ability to export and download saved workﬂows as AWS CloudForm ation or AWS SAM (SAM) templates. For AWS Regions that support AWS Infrastructure Composer, it additiona lly provides the ability to export your workﬂows to Infrastructure Composer and navigates to the Infrastru cture Composer console, where you can continue to work with the newly generated template. To learn more, see Exporting your workﬂow to IaC templates. New feature Step Functions adds the option to use AWS KMS and customer managed keys to encrypt your data July 25, 2024 You can add another layer of security by choosing a customer managed key to encrypt workﬂows, activitie s, and logs. To learn more, see Data at rest encryption in Step Functions. Updates Document structure update July 24, 2024 With page view data and depth analysis, documenta tion sections were restructured to increase visibility of important topics. The navigation was updated to reduce overall depth. Related topics were consolidated. Redirects were added so that bookmarks should lead to the updated locations. Send feedback if you notice errors or omissions after this massive update. Thank you! 1057 AWS Step Functions Change Description Updates AWS managed policy updates - new permission: states:ValidateStateMachineDefinition Added information about new permission to check the syntax of a state machine that you provide. To learn more, see AWS managed policies for AWS Step Functions. Developer Guide Date changed April 29, 2024 New feature Step Functions adds optimized integration for AWS Elemental MediaConvert April 12, 2024 AWS Elemental MediaConvert provides broadcast-grade video and audio ﬁle transcoding, which customers can automate with code to suit their media workﬂows. With the optimized integration for AWS Step Functions in MediaConvert, it is now possible to orchestrate using the low-code visual tool Workﬂow Studio. To learn more, see the documentation to Manage AWS Elemental MediaConv ert with Step Functions. Updates AWS managed policy updates - Update to an existing policy: AWSStepFunctionsReadOnlyAccess April 02, 2024 Added information about new read-only permissions for tags, distributed maps, and versions and aliases. To learn more, see AWS managed policies for AWS Step Functions. 1058 AWS Step Functions Change Description Updates Step Functions adds support for Open Workﬂow metrics Developer Guide Date changed February 29, 2024 With open workﬂow metrics, you now have account-l evel visibility into the number of standard workﬂows in progress as well as your open workﬂow limit. You can manage workloads across all workﬂows, regardles s of how they're started, to ensure smooth workﬂow operations. You can set CloudWatch alarms to monitor your workﬂows and proactively receive alerts as you approach your limits. Once alerted, you can eﬀective ly manage your workﬂows by taking actions such as stopping speciﬁc workﬂows or requesting a limit increase. Open workﬂow metrics is available to use in CloudWatch for standard workﬂows with no additional conﬁguration required. To learn more, see Execution metrics. Updates Service integration additions and updates. For the list of new and updated AWS SDK integrations, see Learning to January 18, 2024 use AWS service SDK integrations in Step Functions. For the full list of services, see Supported AWS SDK service integrations. New feature Use Workﬂow Studio in Infrastructure Composer to build serverless workﬂows using AWS CloudFormation templates. For more information, see Using Workﬂow Studio in Infrastructure Composer to build Step Functions workﬂows. November 27, 2023 New feature Step Functions now lets you directly invoke public HTTPS endpoints and test individual states using a new Test State API. For more information, see: November 26, 2023 • Call HTTPS APIs in Step Functions workﬂows • Using TestState API to test a state in Step Functions 1059 AWS Step Functions Change Description Developer Guide Date changed New feature Step Functions now integrates with Amazon Bedrock. For more information, see the following topics: November 26, 2023 • Invoke and customize Amazon Bedrock models with Step Functions • IAM permissions for Amazon Bedrock • Perform AI prompt-chaining with Amazon Bedrock •
step-functions-dg-290	step-functions-dg.pdf	290	feature Step Functions now lets you directly invoke public HTTPS endpoints and test individual states using a new Test State API. For more information, see: November 26, 2023 • Call HTTPS APIs in Step Functions workﬂows • Using TestState API to test a state in Step Functions 1059 AWS Step Functions Change Description Developer Guide Date changed New feature Step Functions now integrates with Amazon Bedrock. For more information, see the following topics: November 26, 2023 • Invoke and customize Amazon Bedrock models with Step Functions • IAM permissions for Amazon Bedrock • Perform AI prompt-chaining with Amazon Bedrock • Integrating services with Step Functions New feature Step Functions now lets you redrive workﬂow execution s of type Standard from their point of failure. For more November 15, 2023 information, see Restarting state machine executions with redrive in Step Functions and Redriving Map Runs in Step Functions executions. Documentation-only update Published a new topic that explains how to run state machines on a schedule using Amazon EventBridge October 16, 2023 Scheduler. For more information, see Using Amazon EventBridge Scheduler to start a Step Functions state machine execution. New feature Step Functions now integrates with Amazon EMR Serverless. For more information, see the following topics: October 12, 2023 • Create and manage Amazon EMR Serverless applicati ons with Step Functions • Run an EMR Serverless job • Integrating services with Step Functions • Integrating services with Step Functions Documentation-only update Added information about running state machines on a schedule using Amazon EventBridge Scheduler. For more information, see Using EventBridge Scheduler. October 05, 2023 1060 AWS Step Functions Change Description Developer Guide Date changed Update Fixes Update Update Reorganized and updated the Distributed Map state topics for clarity, brevity, and establishing a clear journey map October 6, 2023 for new users. For more information, see Using Map state in Distributed mode for large-scale parallel workloads in Step Functions. Fixed code samples in a tutorial to use AWS CDK v2. For more information, see Using AWS CDK to create a September 19, 2023 Standard workﬂow in Step Functions. Added information about the enhanced error handling capabilities that Step Functions has introduced to identify September 07, 2023 errors clearly and implement retries with greater control. For more information, see Fail workﬂow state and Retrying after an error. Step Functions has added enhancements to Workﬂow Studio for streamlining workﬂow authoring experience. August 31, 2023 For more information, see Developing workﬂows in Step Functions Workﬂow Studio. Documentation-only update Added information about twice the actual metric count reported for the ExecutionsStarted metric. For more information, see Metrics that report a count. Documentation-only update Step Functions has added two new sample projects that demonstrate the following common use cases for the Distributed Map state: July 25, 2023 July 17, 2023 • Processing a CSV ﬁle • Processing data in an Amazon S3 bucket Documentation-only update Published a new topic about deploying state machines using Terraform. For more information, see Using July 5, 2023 Terraform to deploy state machines in Step Functions. 1061 AWS Step Functions Change Description Developer Guide Date changed Documentation-only update Updated the following procedures to match changes to the Amazon EventBridge interface. June 26, 2023 • Automate event delivery • Starting a Step Functions workﬂow in response to events New feature Step Functions now provides the ability to create multiple state machine versions and aliases for improved resiliency June 22, 2023 while deploying serverless workﬂows. For more informati on, see Manage continuous deployments with versions and aliases in Step Functions. Documentation-only update Improved the description of TimeoutSeconds and HeartbeatSeconds ﬁelds to describe how they're diﬀerent from each other. For more information, see Task state ﬁelds. June 22, 2023 Documentation-only update Published a new section that describes how to ﬂatten an array of arrays typically returned as result for Parallel and June 20, 2023 Map states. For more information, see Flattening an array of arrays. Update Step Functions has expanded support for AWS SDK integrations by adding seven AWS services and 468 new June 16, 2023 API actions. For more information, see Supported AWS SDK service integrations and Learning to use AWS service SDK integrations in Step Functions. Documentation-only update Published a new topic that lists the AWS Regions in which recently launched Step Functions features are available. For more information, see Recent feature launches. June 16, 2023 1062 AWS Step Functions Change Description Documentation-only update Step Functions now includes a section about AWS User Notiﬁcations, an AWS service that acts as a central location for your AWS notiﬁcations in the AWS Management Console. For more information, see Events using User Notiﬁcations. Developer Guide Date changed May 4, 2023 Documentation-only update Added a new section that explains about the permissio ns needed to write child workﬂow execution results April 29, 2023 to an Amazon S3 bucket
step-functions-dg-291	step-functions-dg.pdf	291	the AWS Regions in which recently launched Step Functions features are available. For more information, see Recent feature launches. June 16, 2023 1062 AWS Step Functions Change Description Documentation-only update Step Functions now includes a section about AWS User Notiﬁcations, an AWS service that acts as a central location for your AWS notiﬁcations in the AWS Management Console. For more information, see Events using User Notiﬁcations. Developer Guide Date changed May 4, 2023 Documentation-only update Added a new section that explains about the permissio ns needed to write child workﬂow execution results April 29, 2023 to an Amazon S3 bucket encrypted with an AWS Key Management Service (AWS KMS) key. For more informati on, see IAM permissions for AWS KMS key encrypted Amazon S3 bucket. Documentation-only update Added a new topic that explains about the Data ﬂow simulator feature. For more information, see Data ﬂow April 14, 2023 simulator (unsupported). Quota update Added information about default quota of 1000 for open Map Runs in each account. For more information, see April 05, 2023 Quotas related to accounts. Documentation-only update Added a Note about unavailability of X-Ray tracing for the Distributed Map state. For more information, see Trace March 21, 2023 Step Functions request data in AWS X-Ray. Documentation-only update Added information about how Step Functions handles tag-based authorization. For more information, see Tagging state machines and activities in Step Functions and Creating tag-based IAM policies in Step Functions. March 15, 2023 Documentation-only update Added information about how Step Functions parses CSV ﬁles used as input in Distributed Map state. For more information, see CSV ﬁle in an Amazon S3 bucket. March 14, 2023 1063 AWS Step Functions Change Description Developer Guide Date changed Documentation-only update Added information about how Step Functions handles cross-account invocations for the Run a Job (.sync) March 01, 2023 pattern. For more information, see Run a Job (.sync). Documentation-only update Reduce the history retention period of your completed workﬂow executions from 90 days to 30 days. For more February 21, 2023 information about adjusting the retention period, see Execution guarantees in Step Functions workﬂows and Quotas related to state machine executions. Update Step Functions has expanded support for AWS SDK integrations by adding 35 AWS services and 1100 new API February 17, 2023 actions. For more information, see Supported AWS SDK service integrations and Learning to use AWS service SDK integrations in Step Functions. Documentation-only update Published a Getting Started tutorial series that walks you through the process of creating a workﬂow for credit card December 30, 2022 application using Step Functions. For more information, see Learn how to get started with Step Functions. New feature Step Functions adds support to orchestrate large-sca le parallel workﬂows for data processing using a new December 01, 2022 Distributed mode for Map state. For more information, see Using Map state in Distributed mode for large-scale parallel workloads in Step Functions. 1064 AWS Step Functions Change Description Developer Guide Date changed New feature Step Functions now supports access to cross-account AWS resources conﬁgured in other accounts. For more November 18, 2022 information, see • Accessing resources in other AWS accounts in Step Functions • Accessing cross-account AWS resources in Step Functions • Task state Update Step Functions now provides a new console experience for viewing and debugging Express workﬂow executions. For October 18, 2022 more information see: Update • Standard and Express console experience diﬀerences • Viewing execution details in the Step Functions console Added support to optionally specify the Execution RoleArn parameter while using the addStep and addStep.sync APIs for the Amazon EMR optimized service integration. For more information, see Create and manage Amazon EMR clusters with Step Functions. September 20, 2022 Documentation-only update Added a new topic that provides recommendations about optimizing cost while building serverless workﬂows using Step Functions. For more information, see Optimizing costs using Express Workﬂows. September 15, 2022 1065 AWS Step Functions Change Description Update Update Developer Guide Date changed August 31, 2022 Step Functions adds support for 14 new intrinsic functions for performing data processing tasks, such as array manipulations, data encoding and decoding, hash calculations, JSON data manipulation, math function operations, and unique identiﬁer generation. Documentation-only update: Grouped all the existing and newly introduced intrinsic functions into the following categories based on the type of data processing task they help you perform: • Intrinsics for arrays • Intrinsics for data encoding and decoding • Intrinsic for hash calculation • Intrinsics for JSON data manipulation • Intrinsics for Math operations • Intrinsic for String operation • Intrinsic for unique identiﬁer generation • Intrinsic for generic operation For more information, see Intrinsic functions for JSONPath states in Step Functions . Step Functions has expanded support for AWS SDK integrations by adding three more AWS services – AWS Billing Conductor, Amazon GameSparks, and Amazon Pinpoint
step-functions-dg-292	step-functions-dg.pdf	292	newly introduced intrinsic functions into the following categories based on the type of data processing task they help you perform: • Intrinsics for arrays • Intrinsics for data encoding and decoding • Intrinsic for hash calculation • Intrinsics for JSON data manipulation • Intrinsics for Math operations • Intrinsic for String operation • Intrinsic for unique identiﬁer generation • Intrinsic for generic operation For more information, see Intrinsic functions for JSONPath states in Step Functions . Step Functions has expanded support for AWS SDK integrations by adding three more AWS services – AWS Billing Conductor, Amazon GameSparks, and Amazon Pinpoint SMS and Voice V2. For more information, see Learning to use AWS service SDK integrations in Step Functions. July 26, 2022 1066 AWS Step Functions Change Description Documentation-only update Added a new topic to include a summary of all the updates made to AWS SDK integrations supported by Step Functions. For more information, see Learning to use AWS service SDK integrations in Step Functions Developer Guide Date changed July 26, 2022 Documentation-only update AWS Step Functions Developer Guide now includes details about the execution metrics that are emitted speciﬁca June 09, 2022 lly for Express Workﬂows. For more information, see Execution metrics for Express Workﬂows. 1067 AWS Step Functions Change Description Update Step Functions console enhancements Developer Guide Date changed May 09, 2022 The console now features a redesigned Execution Details page that includes the following enhancements: • Ability to identify the reason for a failed execution at a glance. • Two new modes of visualizations for your state machine – Table view and Event view. These views also provide you the ability to apply ﬁlters to only view the informati on of interest. In addition, you can sort the Event view contents based on the event timestamps. • Switch between the diﬀerent iterations of Map state in the Graph view mode using a dropdown list or in the Table view mode's tree view for Map states. • View in-depth information about each state in the workﬂow, including the complete input and output data transfer path and retry attempts for Task or Parallel states. • Miscellaneous enhancements including the option to copy the state machine's execution Amazon Resource Name, view the count of total state machine transitions, and export the execution details in JSON format. Documentation-only updates Added a new topic to explain the various types of information displayed in the Execution Details page. Also, added a tutorial to show how to examine this information. For more information, see: • Viewing execution details in the Step Functions console • Examining state machine executions in Step Functions 1068 AWS Step Functions Change Description Developer Guide Date changed Update Step Functions now provides a workaround to prevent the confused deputy security issue, which arises when an May 02, 2022 entity (a service or an account) is coerced by a diﬀerent entity to perform an action. For more information, see: • Prevent cross-service confused deputy issue Update • Step Functions has expanded support for AWS SDK integrations by adding 21 more AWS services. For more information, see: Supported AWS SDK service integrati ons. • Documentation-only updates: • Added a list of all the exception preﬁxes present in the exceptions that are generated when you erroneously perform an AWS SDK service integrati on with Step Functions. For more information, see: Supported AWS SDK service integrations. April 19, 2022 New feature Step Functions Local now supports AWS SDK integration and mocking of service integrations. For more informati January 28, 2022 on, see: • Using mocked service integrations for testing in Step Functions Local New feature AWS Step Functions now supports creating an Amazon API Gateway REST API with synchronous express state machine as backend integration using the AWS Cloud Development Kit (AWS CDK). For more information, see: December 10, 2021 • Using AWS CDK to create an Express workﬂow in Step Functions 1069 AWS Step Functions Change Description Developer Guide Date changed Update Step Functions has added three new sample projects that demonstrate the integration of Step Functions and November 22, 2021 Amazon Athena's upgraded console. For more informati on, see: • Execute queries in sequence and parallel using Athena • Query large datasets using an AWS Glue crawler • Keep data in a target table updated with AWS Glue and Athena New feature Step Functions has added Amazon VPC endpoints support for Synchronous Express Workﬂows. For more informati November 15, 2021 on, see: • Creating Amazon VPC endpoints for Step Functions Update AWS Step Functions has added three new sample projects that demonstrate how to use the Step Functions AWS October 14, 2021 Batch integration. For more information, see: • Fan out batch jobs with Map state • Run an AWS Batch job with Lambda • Manage a batch job with AWS Batch and
step-functions-dg-293	step-functions-dg.pdf	293	an AWS Glue crawler • Keep data in a target table updated with AWS Glue and Athena New feature Step Functions has added Amazon VPC endpoints support for Synchronous Express Workﬂows. For more informati November 15, 2021 on, see: • Creating Amazon VPC endpoints for Step Functions Update AWS Step Functions has added three new sample projects that demonstrate how to use the Step Functions AWS October 14, 2021 Batch integration. For more information, see: • Fan out batch jobs with Map state • Run an AWS Batch job with Lambda • Manage a batch job with AWS Batch and Amazon SNS New feature AWS Step Functions has added AWS SDK integrations, letting you use the API actions for all of the more than two hundred AWS services. For more information, see: September 30, 2021 • Learning to use AWS service SDK integrations in Step Functions • Gather Amazon S3 bucket info using AWS SDK service integrations 1070 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions has added a visual workﬂow designer, the AWS Step Functions Workﬂow Studio. For more June 17, 2021 Update information, see: • Developing workﬂows in Step Functions Workﬂow Studio AWS Step Functions has added four new APIs, StartBuil dBatch , StopBuildBatch , RetryBuildBatch and DeleteBuildBatch , to the CodeBuild integration. For more information, see: June 4, 2021 • Manage AWS CodeBuild builds with Step Functions New feature AWS Step Functions now integrates with Amazon EventBridge. For more information, see: May 14, 2021 • Add EventBridge events with Step Functions • IAM policies for Step Functions and IAM policies for calling EventBridge • A sample project that shows how to Send a custom event to an EventBridge event bus Update AWS Step Functions has added a new sample project that shows how to use Step Functions and the Amazon April 16, 2021 Redshift Data API to run an ETL/ELT workﬂow. For more information, see: • Run an ETL/ELT workﬂow using Step Functions and the Amazon Redshift API New feature AWS Step Functions has a new data ﬂow simulator in the console. For more information, see: April 8, 2021 • Data ﬂow simulator (unsupported) 1071 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions now integrates with Amazon EMR on EKS. For more information, see: March 29, 2021 • Create and manage Amazon EMR clusters on EKS with AWS Step Functions Update YAML support for state machine deﬁnitions has been added to AWS Toolkit for Visual Studio Code and AWS March 4, 2021 CloudFormation. For more information, see: • AWS Toolkit for Visual Studio Code New feature AWS Step Functions now integrates with AWS Glue DataBrew. For more information, see: January 6, 2021 • Start AWS Glue DataBrew jobs with Step Functions • What is AWS Glue DataBrew? in the DataBrew developer guide. New feature AWS Step Functions Synchronous Express Workﬂows are now available, giving you an easy way to orchestrate November 24, 2020 microservices. For more information, see: • Synchronous and Asynchronous Express Workﬂows in Step Functions • A sample project that shows how to Invoke Synchrono us Express Workﬂows through API Gateway • The StartSyncExecution API documentation. 1072 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions now integrates with Amazon API Gateway. For more information, see: November 17, 2020 • Create API Gateway REST APIs with Step Functions • IAM policies for Step Functions and IAM policies for calls to Amazon API Gateway • A sample project that shows how to Interact with an API managed by API Gateway New feature AWS Step Functions now integrates with Amazon Elastic Kubernetes Service. For more information, see: November 16, 2020 • Create and manage Amazon EKS clusters with Step Functions • IAM policies for Step Functions and IAM policies for calling Amazon EKS • A sample project that shows how to Create and manage an Amazon EKS cluster with a node group New feature AWS Step Functions now integrates with Amazon Athena. For more information, see: October 22, 2020 • Run Athena queries with Step Functions • IAM policies for Step Functions and IAM policies for calling Amazon Athena • A sample project that shows how to Start an Athena query and send a results notiﬁcation 1073 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions now supports tracing end-to-en d workﬂows with AWS X-Ray, giving you full visibility September 14, 2020 across state machine executions and making it easier to analyze and debug your distributed applications. For more information, see: • Trace Step Functions request data in AWS X-Ray • IAM policies for Step Functions and IAM policies using AWS X-Ray in Step Functions • AWS Step Functions API Reference • TracingConﬁguration 1074 AWS
step-functions-dg-294	step-functions-dg.pdf	294	A sample project that shows how to Start an Athena query and send a results notiﬁcation 1073 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions now supports tracing end-to-en d workﬂows with AWS X-Ray, giving you full visibility September 14, 2020 across state machine executions and making it easier to analyze and debug your distributed applications. For more information, see: • Trace Step Functions request data in AWS X-Ray • IAM policies for Step Functions and IAM policies using AWS X-Ray in Step Functions • AWS Step Functions API Reference • TracingConﬁguration 1074 AWS Step Functions Change Description Developer Guide Date changed Update AWS Step Functions now supports payload sizes up to 256 KiB of data as a UTF-8 encoded string. This lets you September 3, 2020 process larger payloads in both Standard and Express workﬂows. Your existing state machines do not need to be changed in order to use the larger payloads. However, you will need to update to the latest versions of the Step Functions SDK and Local Runner to use the updated APIs. For more information, see: • Service quotas • the section called “Using Amazon S3 to pass large data” • States.DataLimitExceeded • the section called “CloudWatch Logs payloads” • AWS Step Functions API Reference • CloudWatchEventsExecutionDataDetails • HistoryEventExecutionDataDetails • GetExecutionHistory • ActivityScheduledEventDetails • ActivitySucceededEventDetails • CloudWatchEventsExecutionDataDetails • ExecutionSucceededEventDetails • LambdaFunctionScheduledEventDetails • ExecutionSucceededEventDetails • StateEnteredEventDetails • StateExitedEventDetails • TaskSubmittedEventDetails • TaskSucceededEventDetails 1075 AWS Step Functions Change Description Update The Amazon States Language has been updated as follows: Developer Guide Date changed August 13, 2020 • Choice Rules (JSONata) has added • A null comparison operator, IsNull. IsNull tests against the JSON null value, and can be used to detect if the output of a previous state is null or not. • Four other new operators have been added, IsBoolean , IsNumeric, IsString and IsTimestamp. • A test for the existence or non-existence of a ﬁeld using the IsPresent operator. IsPresent can be used to prevent States.Runtime errors when there is an attempt to access a non-existent key. • Wildcard pattern matching to support string comparison against patterns with one or more wildcards. • Comparison between two variables for supported comparison operators. • Timeout and heartbeat values in a Task state can now be provided dynamically from the state input instead of a ﬁxed value using the TimeoutSecondsPath and HeartbeatSecondsPath ﬁelds. See the Task workﬂow state state for more information. • The new ResultSelector ﬁeld provides a way to manipulate a state’s result before ResultPath is applied. The ResultSelector ﬁeld is an optional ﬁeld in the Map workﬂow state, Parallel workﬂow state, and Task workﬂow state states. • Intrinsic functions for JSONPath states in Step Functions have been added to allow basic operation s without Task states. Intrinsic functions can be used 1076 AWS Step Functions Change Description within the Parameters and ResultSelector ﬁelds. Update AWS Step Functions now supports the Amazon SageMaker AI CreateProcessingJob more information, see: API call. For • Create and manage Amazon SageMaker AI jobs with Step Functions • Preprocess data and train a machine learning model with Amazon SageMaker AI, a sample project that demonstrates CreateProcessingJob . Developer Guide Date changed August 4, 2020 New feature AWS Step Functions is now supported by AWS Serverless Application Model, making it easier to integrate workﬂow May 27, 2020 orchestration into your serverless applications. For more information, see: • Using AWS SAM to build Step Functions workﬂows • AWS::Serverless::StateMachine • AWS SAM Policy Templates New feature AWS Step Functions has introduced a new synchronous invocation for nesting Step Functions executions. The May 19, 2020 new invocation, arn:aws:states:::states:sta , returns a JSON object. The rtExecution.sync:2 original invocation, arn:aws:states:::states:sta , continues to be supported, and rtExecution.sync returns a JSON-escaped string. For more information, see: • Start a new AWS Step Functions state machine from a running execution 1077 AWS Step Functions Change Description Developer Guide Date changed New feature AWS Step Functions now integrates with AWS CodeBuild. For more information, see: May 5, 2020 • Integrating services with Step Functions • Manage AWS CodeBuild builds with Step Functions • Integrating services with Step Functions New feature Step Functions is now supported in AWS Toolkit for Visual Studio Code, making it easier to create and visualize state March 31, 2020 machine based workﬂows without leaving your code editor. Update You can now conﬁgure logging to Amazon CloudWatch Logs for Standard workﬂows. For more information, see: February 25, 2020 • Using CloudWatch Logs to log execution history in Step Functions New feature AWS Step Functions can now be accessed without requiring a public IP address, directly from Amazon Virtual December 23, 2019 Private Cloud (VPC). For more information, see: • Creating Amazon VPC endpoints for Step Functions 1078 AWS Step Functions Change Description
step-functions-dg-295	step-functions-dg.pdf	295	in AWS Toolkit for Visual Studio Code, making it easier to create and visualize state March 31, 2020 machine based workﬂows without leaving your code editor. Update You can now conﬁgure logging to Amazon CloudWatch Logs for Standard workﬂows. For more information, see: February 25, 2020 • Using CloudWatch Logs to log execution history in Step Functions New feature AWS Step Functions can now be accessed without requiring a public IP address, directly from Amazon Virtual December 23, 2019 Private Cloud (VPC). For more information, see: • Creating Amazon VPC endpoints for Step Functions 1078 AWS Step Functions Change Description Developer Guide Date changed New feature Express Workﬂows are a new workﬂow type, suitable for high-volume event processing workloads such as IoT data December 3, 2019 ingestion, streaming data processing and transformation, and mobile application backends. For more information, review the following new and updated topics. • Choosing workﬂow type in Step Functions • Execution guarantees in Step Functions workﬂows • Integrating services with Step Functions • Integrating services with Step Functions • Process high-volume messages from Amazon SQS with Step Functions Express workﬂows • Perform selective checkpointing using Standard and Express workﬂows • Step Functions service quotas • Step Functions service quotas • Using CloudWatch Logs to log execution history in Step Functions • AWS Step Functions API Reference • CreateStateMachine • UpdateStateMachine • DescribeStateMachine • DescribeStateMachineForExecution • StopExecution • DescribeExecution • GetExecutionHistory • ListExecutions • ListStateMachines 1079 AWS Step Functions Change Description Developer Guide Date changed • StartExecution • CloudWatchLogsLogGroup • LogDestination • LoggingConﬁguration New feature AWS Step Functions now integrates with Amazon EMR. For more information, see: November 19, 2019 • Integrating services with Step Functions • Create and manage Amazon EMR clusters with Step Functions • Integrating services with Step Functions Update AWS Step Functions has released the AWS Step Functions Data Science SDK. For more information, see the November 7, 2019 following. • Project on Github • SDK Documentation • The following Example Notebooks, which are available in the SageMaker AI console and the related GitHub project. • hello_world_workflow.ipynb • machine_learning_workflow_abalone.ip ynb • training_pipeline_pytorch_mnist.ipyn b 1080 AWS Step Functions Change Description Update Step Functions now supports more API actions for Amazon SageMaker AI, and includes two new sample projects to demonstrate the functionality. For more information, see the following. • Create and manage Amazon SageMaker AI jobs with Step Functions • Integrating services with Step Functions • Train a machine learning model using Amazon SageMaker AI • Tune the hyperparameters of a machine learning model in SageMaker AI New feature Step Functions supports starting new workﬂow execution s by calling StartExecution as an integrated service API. See: • Start workﬂow executions from a task state in Step Functions • Start a new AWS Step Functions state machine from a running execution • Integrating services with Step Functions • IAM Policies for Starting Step Functions Workﬂow Executions Developer Guide Date changed October 3, 2019 August 12, 2019 1081 Developer Guide Date changed May 23, 2019 AWS Step Functions Change Description New feature Step Functions includes the ability to pass a task token to integrated services, and pause the execution until that task token is returned with SendTaskSuccess or SendTaskFailure . See: • Discover service integration patterns in Step Functions • Wait for a Callback with Task Token • Create a callback pattern example with Amazon SQS, Amazon SNS, and Lambda • Integrating services with Step Functions • Deploying a workﬂow that waits for human approval in Step Functions • Service Integration Metrics Step Functions now provides a way to access dynamic information about your current execution directly in the "Parameters" ﬁeld of a state deﬁnition. See: • Accessing execution data from the Context object in Step Functions • Pass Context object nodes as parameters New feature Step Functions supports CloudWatch Events for execution status changes, see: May 8, 2019 • Automating Step Functions event delivery with EventBridge New feature Step Functions supports IAM permissions using tags. For more information, see: March 5, 2019 • Tagging state machines and activities in Step Functions • Creating tag-based IAM policies in Step Functions 1082 AWS Step Functions Change Description New feature New feature New feature New feature New feature New feature Developer Guide Date changed February 4, 2019 January 15, 2018 January 7, 2019 Step Functions Local is now available. You can run Step Functions on your local machine for testing and development. Step Functions Local is available for download as either a Java application, or as a Docker image. See Testing state machines with Step Functions Local (unsupported). AWS Step Functions is now available in the Beijing and Ningxia regions. Step Functions supports resource tagging to help track your cost allocation. You can tag state machines on the Details page, or through API actions. See Tagging state machines
step-functions-dg-296	step-functions-dg.pdf	296	New feature Developer Guide Date changed February 4, 2019 January 15, 2018 January 7, 2019 Step Functions Local is now available. You can run Step Functions on your local machine for testing and development. Step Functions Local is available for download as either a Java application, or as a Docker image. See Testing state machines with Step Functions Local (unsupported). AWS Step Functions is now available in the Beijing and Ningxia regions. Step Functions supports resource tagging to help track your cost allocation. You can tag state machines on the Details page, or through API actions. See Tagging state machines and activities in Step Functions. AWS Step Functions is now available in the Europe (Paris), and South America (São Paulo) regions. December 13, 2018 AWS Step Functions is now available the Europe (Stockhol m) region. December 12, 2018 Step Functions now integrates with some AWS services. You can now directly call and pass parameters to the November 29, 2018 API of these integrated services from a task state in the Amazon States Language. For more information, see: • Integrating services with Step Functions • Passing parameters to a service API in Step Functions • Integrating services with Step Functions Update Improved the description of TimeoutSeconds and HeartbeatSeconds in the documentation for task states. See Task workﬂow state. October 24, 2018 1083 AWS Step Functions Change Description Update Improved the description for the Maximum execution history size limit and provided a link to the related best practices topic. Developer Guide Date changed October 17, 2018 Update Update Update Update Update Update Update • Quotas related to state machine executions • Starting new executions to avoid reaching the history quota in Step Functions Added a new tutorial to the AWS Step Functions documentation: See Starting a Step Functions workﬂow in September 25, 2018 response to events. Removed the entry Maximum executions displayed in Step Functions console from the limits documentation. See September 13, 2018 Step Functions service quotas. Added a best practices topic to the AWS Step Functions documentation on improving latency when polling for August 30, 2018 activity tasks. See Avoiding latency when polling for activity tasks. Improved the AWS Step Functions topic on activities and activity workers. See Learn about Activities in Step August 29, 2018 Functions. Improved the AWS Step Functions topic on CloudTrail integration. See Recording Step Functions API calls with AWS CloudTrail. Added JSON examples to AWS CloudFormation tutorial. See Using AWS CloudFormation to create a workﬂow in Step Functions. August 7, 2018 June 23, 2018 Added a new topic on handling Lambda service errors. See Handle transient Lambda service exceptions. June 20, 2018 1084 AWS Step Functions Change Description New feature New feature Update Update Developer Guide Date changed June 28, 2018 AWS Step Functions is now available the Asia Paciﬁc (Mumbai) region. AWS Step Functions is now available the AWS GovCloud (US-West) region. For information about using Step June 28, 2018 Functions in the AWS GovCloud (US-West) Region, see AWS GovCloud (US). Improved documentation on error handling for Parallel states. See Error Handling. June 20, 2018 Improved documentation about Input and Output processing in Step Functions. Learn how to use June 7, 2018 InputPath , ResultPath , and OutputPath to control the ﬂow of JSON through your workﬂows, states, and tasks. See: • Processing input and output in Step Functions • Specifying state output using ResultPath in Step Functions Update New feature Improved code examples for parallel states. See Parallel workﬂow state. June 4, 2018 You can now monitor API and Service metrics in CloudWatch. See Monitoring Step Functions metrics using May 25, 2018 Amazon CloudWatch. 1085 AWS Step Functions Change Description Update StartExecution , StopExecution , and StateTran sition now have increased throttling limits in the following regions: • US East (N. Virginia) • US West (Oregon) • Europe (Ireland) Developer Guide Date changed May 16, 2018 For more information see Step Functions service quotas. New feature AWS Step Functions is now available the US West (N. California) and Asia Paciﬁc (Seoul) regions. See AWS May 5, 2018 Services by Region for a list of supported regions. Update Update Update Updated procedures and images to match changes to the interface. April 25, 2018 Added a new tutorial that shows how to start a new execution to continue your work. See Continue long- April 19, 2018 running workﬂows using Step Functions API (recommen ded). This tutorial describes a design pattern that can help avoid some service limitations. See Starting new executions to avoid reaching the history quota in Step Functions. Improved introduction to states documentation by adding conceptual information about state machines. See Discovering workﬂow states to use in Step Functions. March 9, 2018 1086 Developer Guide Date changed February 19, 2018 AWS Step Functions Change Description New feature • When you create a new
step-functions-dg-297	step-functions-dg.pdf	297	a new tutorial that shows how to start a new execution to continue your work. See Continue long- April 19, 2018 running workﬂows using Step Functions API (recommen ded). This tutorial describes a design pattern that can help avoid some service limitations. See Starting new executions to avoid reaching the history quota in Step Functions. Improved introduction to states documentation by adding conceptual information about state machines. See Discovering workﬂow states to use in Step Functions. March 9, 2018 1086 Developer Guide Date changed February 19, 2018 AWS Step Functions Change Description New feature • When you create a new state machine, you must acknowledge that AWS Step Functions will create an IAM role which allows access to your Lambda functions. • Updated the following tutorials to reﬂect the minor changes in the state machine creation workﬂow: • Creating a Step Functions state machine that uses Lambda • Creating an Activity state machine using Step Functions • Handling error conditions using a Step Functions state machine • Iterate a loop with a Lambda function in Step Functions Update Added a topic that describes an example activity worker written in Ruby. This implementation can be used to February 6, 2018 create a Ruby activity worker directly, or as a design pattern for creating an activity worker in another language. See Example: Activity Worker in Ruby. Update Added a new tutorial describing a design pattern that uses a Lambda function to iterate a count. January 31, 2018 See Creating a Step Functions state machine that uses Lambda. Update Updated content on IAM permissions to include DescribeStateMachineForExecution UpdateStateMachine APIs. and See Creating granular permissions for non-admin users in Step Functions. January 26, 2018 1087 AWS Step Functions Developer Guide Change Description Update Update Update Update Date changed January 25, 2018 January 24, 2018 January 23, 2018 Added newly available regions: Canada (Central), Asia Paciﬁc (Singapore). Updated tutorials and procedures to reﬂect that IAM allows you to select Step Functions as a role. Added a new Best Practices topic that suggests not passing large payloads between states. See Using Amazon S3 ARNs instead of passing large payloads in Step Functions. Corrected procedures to match updated interface for creating a state machine: January 17, 2018 • Creating a Step Functions state machine that uses Lambda • Creating an Activity state machine using Step Functions • Handling error conditions using a Step Functions state machine 1088 AWS Step Functions Change Description New Feature You can use Sample Projects to quickly provision state machines and all related AWS resources. See Deploy a state machine using a starter template for Step Functions, Developer Guide Date changed January 11, 2018 Available sample projects include: • Poll for job status with Lambda and AWS Batch • Create a task timer with Lambda and Amazon SNS Note These sample projects and related documentation replace tutorials that described implementing the same functionality. Update Added a Best Practices section that includes information on avoiding stuck executions. See Best practices for Step January 5, 2018 Functions. Update Added a note on how retries can aﬀect pricing: December 8, 2017 Note Retries are treated as state transitions. For information about how state transitions aﬀect billing, see Step Functions Pricing. 1089 AWS Step Functions Change Description Update Added information related to resource names: Developer Guide Date changed December 6, 2017 Note Step Functions accepts names for state machines, executions, activities, and labels that contain non-ASCII characters. Because such character s will not work with Amazon CloudWatch, we recommend using only ASCII characters so you can track metrics in CloudWatch. Update Improved security overview information and added a topic on granular IAM permissions. See Security in AWS November 27, 2017 Step Functions and Creating granular permissions for non-admin users in Step Functions. 1090 AWS Step Functions Change Description Update Added a note to clarify Lambda.Unknown errors and linked to the Lambda documentation in the following sections: • Error names • Step 3: Create a state machine with a Catch ﬁeld Developer Guide Date changed October 17, 2017 Note Unhandled errors in Lambda runtimes were historically reported only as Lambda.Unknown . In newer runtimes, timeouts are reported as Sandbox.Timedout in the error output. When Lambda exceeds the maximum number of invocations, the reported error will be Lambda.To . oManyRequestsException Match on Lambda.Unknown , Sandbox.T imedout , States.ALL , and States.Ta skFailed to handle possible errors. For more information about Lambda Handled and Unhandled errors, see FunctionError in the AWS Lambda Developer Guide. Update Corrected and clariﬁed IAM instructions and updated the screenshots in all tutorials. October 11, 2017 1091 Developer Guide Date changed October 6, 2017 AWS Step Functions Change Description Update • Added new screenshots for state machine execution results to reﬂect changes in the Step Functions console. Rewrote the Lambda instructions in the following tutorials to
step-functions-dg-298	step-functions-dg.pdf	298	number of invocations, the reported error will be Lambda.To . oManyRequestsException Match on Lambda.Unknown , Sandbox.T imedout , States.ALL , and States.Ta skFailed to handle possible errors. For more information about Lambda Handled and Unhandled errors, see FunctionError in the AWS Lambda Developer Guide. Update Corrected and clariﬁed IAM instructions and updated the screenshots in all tutorials. October 11, 2017 1091 Developer Guide Date changed October 6, 2017 AWS Step Functions Change Description Update • Added new screenshots for state machine execution results to reﬂect changes in the Step Functions console. Rewrote the Lambda instructions in the following tutorials to reﬂect changes in the Lambda console: • Creating a Step Functions state machine that uses Lambda • Creating a Job Status Poller • Creating a Task Timer • Handling error conditions using a Step Functions state machine • Corrected and clariﬁed information about creating state machines in the following sections: • Creating an Activity state machine using Step Functions Update Rewrote the IAM instructions in the following sections to reﬂect changes in the IAM console: October 5, 2017 • Creating an IAM role for your state machine in Step Functions • Creating a Step Functions state machine that uses Lambda • Creating a Job Status Poller • Creating a Task Timer • Handling error conditions using a Step Functions state machine • Creating a Step Functions API using API Gateway Update Rewrote the State Machine Data section. September 28, 2017 1092 AWS Step Functions Change Description Developer Guide Date changed New feature The limits related to API action throttling are increased for all regions where Step Functions is available. September 18, 2017 Update • Corrected and clariﬁed information about starting new executions in all tutorials. • Corrected and clariﬁed information in the Quotas related to accounts section. September 14, 2017 Update Rewrote the following tutorials to reﬂect changes in the Lambda console: August 28, 2017 • Creating a Step Functions state machine that uses Lambda • Handling error conditions using a Step Functions state machine • Creating a Job Status Poller New feature Step Functions is available in Europe (London). August 23, 2017 New feature New feature The visual workﬂows of state machines let you zoom in, zoom out, and center the graph. August 21, 2017 Important An execution can't use the name of another execution for 90 days. August 18, 2017 When you make multiple StartExecution calls with the same name, the new execution doesn't run. For more information, see the name request parameter of the StartExecution API action in the AWS Step Functions API Reference. 1093 AWS Step Functions Change Description Developer Guide Date changed Update Added information about an alternative way of passing the state machine ARN to the Creating a Step Functions August 17, 2017 API using API Gateway tutorial. Update Added the new Creating a Job Status Poller tutorial. New feature • Step Functions emits the ExecutionThrottled CloudWatch metric. For more information, see Monitoring Step Functions metrics using Amazon CloudWatch. • Added the Quotas related to state throttling section. August 10, 2017 August 3, 2017 Update Update Update Updated the instructions in the Step 1: Create an IAM Role for API Gateway section. July 18, 2017 June 23, 2017 June 22, 2017 Corrected and clariﬁed information in the Choice workﬂow state section. Added information about using resources under other AWS accounts to the following tutorials: • Creating a Step Functions state machine that uses Lambda • Using AWS CloudFormation to create a workﬂow in Step Functions • Creating an Activity state machine using Step Functions • Handling error conditions using a Step Functions state machine 1094 AWS Step Functions Change Description Update Corrected and clariﬁed information in the following sections: • Handling error conditions using a Step Functions state machine • Discovering workﬂow states to use in Step Functions • Handling errors in Step Functions workﬂows Developer Guide Date changed June 21, 2017 Update Rewrote all tutorials to match the Step Functions console refresh. June 12, 2017 New feature Step Functions is available in Asia Paciﬁc (Sydney). Update Update Update Update Update Update Update Restructured the Using Amazon States Language to deﬁne Step Functions workﬂows section. Corrected and clariﬁed information in the Creating an Activity state machine using Step Functions section. Corrected the code examples in the State machine examples using Retry and using Catch section. Restructured this guide using AWS documentation standards. Corrected and clariﬁed information in the Parallel workﬂow state section. June 8, 2017 June 7, 2017 June 6, 2017 June 5, 2017 May 31, 2017 May 25, 2017 Merged the Paths and Filters sections into the Processing input and output in Step Functions section. May 24, 2017 Corrected and clariﬁed information in the Monitoring Step Functions metrics using Amazon CloudWatch section. May 15, 2017 1095 AWS Step Functions Change Description Developer Guide
step-functions-dg-299	step-functions-dg.pdf	299	state machine using Step Functions section. Corrected the code examples in the State machine examples using Retry and using Catch section. Restructured this guide using AWS documentation standards. Corrected and clariﬁed information in the Parallel workﬂow state section. June 8, 2017 June 7, 2017 June 6, 2017 June 5, 2017 May 31, 2017 May 25, 2017 Merged the Paths and Filters sections into the Processing input and output in Step Functions section. May 24, 2017 Corrected and clariﬁed information in the Monitoring Step Functions metrics using Amazon CloudWatch section. May 15, 2017 1095 AWS Step Functions Change Description Developer Guide Date changed Update Update Update Update Update Updated the GreeterActivities.java worker code in the Creating an Activity state machine using Step May 9, 2017 Functions tutorial. Added an introductory video to the What is Step Functions? section. Corrected and clariﬁed information in the following tutorials: April 19, 2017 April 19, 2017 • Creating a Step Functions state machine that uses Lambda • Creating an Activity state machine using Step Functions • Handling error conditions using a Step Functions state machine Added information about Lambda templates to the Creating a Step Functions state machine that uses April 6, 2017 Lambda and Handling error conditions using a Step Functions state machine tutorials. Changed the "Maximum input or result data size" limit to "Maximum input or result data size for a task, state, or March 31, 2017 execution" (32,768 characters). For more information, see Quotas related to task executions. New feature • Step Functions supports executing state machines by setting Step Functions as Amazon CloudWatch Events targets. New feature • Step Functions allows Lambda function error handling as the preferred error handling method. • Updated the Handling error conditions using a Step Functions state machine tutorial and the Handling errors in Step Functions workﬂows section. March 21, 2017 March 16, 2017 1096 AWS Step Functions Change Description New feature Step Functions is available in Europe (Frankfurt). Update Reorganized the topics in the table of contents and updated the following tutorials: • Creating a Step Functions state machine that uses Lambda • Creating an Activity state machine using Step Functions • Handling error conditions using a Step Functions state machine New feature • The State Machines page of the Step Functions console includes the Copy to New and Delete buttons. • Updated the screenshots to match the console changes. New feature • Step Functions supports creating APIs using API Gateway. • Added the Creating a Step Functions API using API Gateway tutorial. New feature • Step Functions supports integration with AWS CloudFormation. • Added the Using AWS CloudFormation to create a workﬂow in Step Functions tutorial. Developer Guide Date changed March 7, 2017 February 23, 2017 February 23, 2017 February 14, 2017 February 10, 2017 Update Clariﬁed the current behavior of the ResultPath and OutputPath ﬁelds in relation to Parallel states. February 6, 2017 Update • Clariﬁed state machine naming restrictions in tutorials. • Corrected some code examples. January 5, 2017 Update Updated Lambda function examples to use the latest programming model. December 9, 2016 1097 AWS Step Functions Change Description Initial release Initial release of AWS Step Functions. Developer Guide Date changed December 1, 2016 1098
storage-on-aws-how-to-choose-001	storage-on-aws-how-to-choose.pdf	1	AWS Decision Guide Choosing an AWS storage service Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Choosing an AWS storage service AWS Decision Guide Choosing an AWS storage service: AWS Decision Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Choosing an AWS storage service Table of Contents AWS Decision Guide Decision guide .................................................................................................................................. 1 Introduction ................................................................................................................................................... 1 Understand ..................................................................................................................................................... 2 Deﬁnitions ................................................................................................................................................. 3 Migration options .................................................................................................................................... 4 Consider .......................................................................................................................................................... 4 Choose ............................................................................................................................................................. 8 Use ................................................................................................................................................................. 10 Explore .......................................................................................................................................................... 17 Document history .......................................................................................................................... 18 iii Choosing an AWS storage service AWS Decision Guide Choosing an AWS storage service Taking the ﬁrst step Purpose Last updated Covered services Help determine which AWS storage service is the best ﬁt for your organization. June 26, 2024 • Amazon S3 • Amazon EBS • Amazon EFS • Amazon FSx • Amazon File Cache • AWS Backup • AWS DataSync • AWS Snow Family • AWS Storage Gateway • AWS Transfer Family Introduction AWS oﬀers a broad portfolio of reliable, scalable, and secure storage services for storing, accessing, protecting, and analyzing your data. This makes it easier to match your storage methods with your needs, and provides storage options that are not easily achievable with on-premises infrastructure. When selecting a storage service, ensuring that it aligns with your access patterns will be critical to achieving the performance you want. You can select from block, ﬁle, and object storage services as well as cloud data migration options for your workload. Choosing the right storage service for your workload requires you to make a series of decisions based on your business needs. This decision guide will help you ask the right questions, provide a clear path for implementation, and help you migrate from your existing on-premises storage. Introduction 1 Choosing an AWS storage service AWS Decision Guide This six minute clip is from a 55 minute recording of a presentation by AWS senior storage solutions architects Kevin McDonald and Victor Munoz at the 2022 AWS Summit. It provides an overview of available AWS storage services. Understand Data is a cornerstone of successful application deployments, analytics workﬂows, and machine learning innovations. Well-architected systems use multiple storage services and enable diﬀerent features to improve performance. In many cases, however, choosing the right storage service will start with how well it aligns with what you're already using (or are familiar with). Working with storage services that you are familiar with will make it easier for you to get started - and can make migration of your data easier and potentially faster. For example, services in the Amazon FSx data storage family come in four options that align to popular ﬁle systems: • Amazon FSx for Windows File Server provides fully managed Microsoft Windows ﬁle servers, backed by a fully native Windows ﬁle system. Understand 2 Choosing an AWS storage service AWS Decision Guide • Amazon FSx for Lustre allows you to launch and run the high-performance Lustre ﬁle system. • Amazon FSx for OpenZFS a fully managed ﬁle storage service that enables you to move data to AWS from on-premises ZFS or other Linux-based ﬁle servers. • Amazon FSx for NetApp ONTAP a fully managed service that provides highly reliable, scalable, high-performing, and feature-rich ﬁle storage built on NetApp's popular ONTAP ﬁle system. Deﬁnitions There are AWS service options for the following storage types: • Block — Block storage is technology that controls data storage and storage devices. It takes any data, like a ﬁle or database entry, and divides it into blocks of equal sizes. The block storage system then stores the data block on underlying physical storage in a manner that is optimized for fast access and retrieval. • File system — File systems store data in a hierarchical structure of ﬁles and folders. In network environments, ﬁle-based storage often uses network-attached storage (NAS) technology. NAS allows users to access network storage data in similar ways to a local hard drive. File storage is user-friendly and allows users to manage ﬁle-sharing control. • Object — Object storage is a technology that stores and manages data in an unstructured format called objects. Each object is tagged with a unique identiﬁer and contains metadata that describes the underlying content. • Cache — A cache is a high-speed data storage layer used to temporarily store frequently accessed or recently used data closer to
storage-on-aws-how-to-choose-002	storage-on-aws-how-to-choose.pdf	2	of ﬁles and folders. In network environments, ﬁle-based storage often uses network-attached storage (NAS) technology. NAS allows users to access network storage data in similar ways to a local hard drive. File storage is user-friendly and allows users to manage ﬁle-sharing control. • Object — Object storage is a technology that stores and manages data in an unstructured format called objects. Each object is tagged with a unique identiﬁer and contains metadata that describes the underlying content. • Cache — A cache is a high-speed data storage layer used to temporarily store frequently accessed or recently used data closer to the point of access, with the aim of improving system performance and reducing latency. It serves as a buﬀer between the slower and larger primary storage (such as disks or remote storage) and the computing resources that need to access the data. • Hybrid/Edge — Hybrid/Edge storage combines on-premises storage infrastructure with cloud storage services, allowing data mobility between the two environments based on requirements like performance, cost, and compliance. It provides beneﬁts such as low-latency access, cost optimization, data sovereignty, cloud scalability, and business continuity. Deﬁnitions 3 Choosing an AWS storage service Migration options AWS Decision Guide In addition to choosing a storage service, you will need to make choices about how you migrate your data to live within the chosen services. AWS oﬀers several choices to migrate your data - based on whether it needs to live online or oﬄine. • Online migration involves transferring data and applications over the internet while they are still running in the on-premises data center. This approach can be more eﬃcient than oﬄine migration since it minimizes downtime and enables organizations to start using cloud resources sooner. However, it requires a reliable internet connection and may not be suitable for large amounts of data or mission-critical applications. • Oﬄine migration involves moving data and applications without any connection to the internet. This approach requires physically transporting the data on external hard drives or other storage media to the cloud provider’s data center. This method is typically used when there are large amounts of data to transfer, limited bandwidth or connectivity, or concerns about security and privacy. There are two key considerations: • Speed - Choose online migration when speed matters. Online is measured in minutes or hours, and oﬄine can be measured by days. If data is frequently updated and time-critical, choose online. Choose oﬄine when it’s a one-time move, and not time-critical. • Bandwidth - Moving data online takes away from available bandwidth used for day-to-day. Choose oﬄine when there are network constraints, and data can be oﬄine while in transit without disrupting your business. AWS services in the Snow Family oﬀer an option for oﬄine migration. Consider You might be considering AWS storage services because you are migrating an existing application to the cloud or building a new application in the cloud. When moving data to the cloud, it is important for you to understand where you are moving it, the potential use cases, the type of data you are moving, and the network resources available. Here's some of the criteria to consider when choosing an AWS storage service. Migration options 4 Choosing an AWS storage service Protocol AWS storage services oﬀer multiple protocol options: AWS Decision Guide • Block storage oﬀers high-performance storage that is direct-attached to a compute instance with low-latency access, making it suitable for applications that require fast and consistent I/ O operations. • File-based storage is natively mountable from virtually any operating system using industry- standard protocols like NFS and SMB. It provides simple storage for workloads that need access to shared data across multiple compute instances. • Object storage provides easy access to data through an application programming interface (API) over the internet and is well-suited to read-heavy workloads (such as streaming applications and services). Protocols play a crucial role when considering AWS storage services as they determine how data is accessed, transferred, and managed within the storage environment. Client type It's important to consider the operating system of the clients that will be accessing the data. Windows-based clients can use ﬁle-based storage options such as Amazon FSx for Windows File Server. It provides highly available storage to your Windows applications with full Server Message Block (SMB) support. Amazon FSx for Lustre (for high-performance ﬁle systems) is designed for use with Unix/ Linux-based ﬁle systems. FSx for Lustre is optimized for workloads where speed matters, such as machine learning, high performance computing (HPC), video processing, and ﬁnancial modeling. The choice of client type for an AWS storage service is critical to ensure easy access and sharing of data across workloads. Selecting a service that is compatible with the ﬁle systems and protocols used by your clients is key to avoiding compatibility issues and ensuring
storage-on-aws-how-to-choose-003	storage-on-aws-how-to-choose.pdf	3	highly available storage to your Windows applications with full Server Message Block (SMB) support. Amazon FSx for Lustre (for high-performance ﬁle systems) is designed for use with Unix/ Linux-based ﬁle systems. FSx for Lustre is optimized for workloads where speed matters, such as machine learning, high performance computing (HPC), video processing, and ﬁnancial modeling. The choice of client type for an AWS storage service is critical to ensure easy access and sharing of data across workloads. Selecting a service that is compatible with the ﬁle systems and protocols used by your clients is key to avoiding compatibility issues and ensuring seamless data access and transfer. Performance Performance is a critical factor to consider when choosing an AWS storage service. There are several factors to consider when evaluating storage performance, including IOPS (input/output operations per second), access patterns, latency, and throughput or bandwidth. It is important to ask questions such as: Consider 5 Choosing an AWS storage service AWS Decision Guide • Is your workload latency sensitive? • Do other metrics (such as IOPS or throughput) dominate your applications performance proﬁle? • Is your workload read or write-heavy? Migration strategy and risks The skills of your organization are a major factor when deciding which container services you use. The approach you take can require some investment in DevOps and Site Reliability Engineer (SRE) teams. Building out an automated pipeline to deploy applications is common for most modern application development. Some factors to consider when migrating your on-premises storage to AWS are: • Data transfer: what is the most eﬃcient method to transfer your data to AWS? • Compatibility: For example, if you already leverage NetApp ONTAP appliances on-premises services (such as Amazon FSx for NetApp ONTAP) provide a seamless migration path. • Application integration: Evaluate how your applications will integrate with AWS storage services. Consider any necessary modiﬁcations or conﬁgurations required to enable seamless connectivity and functionality between your applications and the AWS environment. • Data Management and lifecycle: Plan for data management tasks such as backup, replication, and lifecycle management in the AWS environment. Consider AWS services and features that can help automate these tasks, such as versioning, lifecycle policies, and cross- region replication. • Security and compliance: Ensure that your data remains secure during the migration process. Implement appropriate security measures, such as encryption and access controls, to protect your data both in transit and at rest. • Cost optimization: Analyze the cost implications of migrating your storage solution to AWS. Consider factors such as storage pricing, data transfer costs, and any associated services or features required to optimize costs. By carefully considering these factors, you can ensure a successful migration from an on- premises storage solution to AWS storage services, minimizing disruptions, and maximizing the beneﬁts of cloud storage. Consider 6 Choosing an AWS storage service AWS Decision Guide Backup and protection requirements Backup and protection requirements are critical factors to consider when choosing an AWS storage service because they help ensure the availability and durability of your data. Without adequate backup and protection measures, data can be lost due to accidental deletion, hardware failure, or natural disasters, which can have severe consequences for your business. Familiarize yourself with services such as AWS Backup, which can backup your data on demand or automatically as part of a scheduled backup plan. AWS Backup also oﬀers cross-region replication which can be particularly valuable if you have business continuity or compliance requirements to store backups a minimum distance away from your production data. Disaster recovery Disaster recovery is a critical consideration when choosing an AWS storage service because it helps ensure business continuity in the event of a disaster or outage. A disaster can be caused by various factors, such as natural disasters, human error, or cyber attacks, and can result in signiﬁcant data loss and downtime. Choosing a storage service that provides disaster recovery features, such as replication across multiple availability zones, can help minimize the impact of a disaster on your business. It's important to consider factors such as recovery time objectives (RTO) and recovery point objectives (RPO) when evaluating disaster recovery options and choose a storage service that meets your business needs. Cost Beyond the base storage costs, there are other factors that impact pricing such as storage capacity, data transfer, and availability that impacts the total cost of storage. The following can help you reduce cost when using an AWS storage service: • Use the appropriate storage service for your workload type. • Use AWS Cost Explorer and other billing tools to monitor organizational speed. • Understand your data and how it is being used. We also recommend that you use the AWS Pricing Calculator to estimate your cost when choosing an AWS storage service. Consider 7 Choosing an AWS storage service Security AWS Decision Guide Security
storage-on-aws-how-to-choose-004	storage-on-aws-how-to-choose.pdf	4	there are other factors that impact pricing such as storage capacity, data transfer, and availability that impacts the total cost of storage. The following can help you reduce cost when using an AWS storage service: • Use the appropriate storage service for your workload type. • Use AWS Cost Explorer and other billing tools to monitor organizational speed. • Understand your data and how it is being used. We also recommend that you use the AWS Pricing Calculator to estimate your cost when choosing an AWS storage service. Consider 7 Choosing an AWS storage service Security AWS Decision Guide Security at AWS is a shared responsibility. AWS provides a secure foundation for customers to build and deploy their applications, but customers are responsible for implementing their own security measures to protect their data, applications, and infrastructure. You should consider aspects of security such as access control, data encryption, compliance requirements, monitoring and logging, and incident response when choosing an AWS storage service. By doing so, you can help ensure that your data is protected while using AWS services. Choose Now that you know the criteria you should use to evaluate your storage options, you are ready to choose which AWS storage services are right for your business needs. The following table highlights which storage options are optimized for which circumstances. Use it to help determine the one that is the best ﬁt for your use case. Storage type What is it optimized for? Storage services or tools Block File system Applications requiring low- latency, high-performance durable storage attached to single Amazon EC2 instances or containers, such as databases and general-p urpose local instance storage. Applications and workloads requiring shared read and write access across multiple Amazon EC2 instances or containers, or from multiple on-prem servers, such as team ﬁle shares, highly-av ailable enterprise applicati ons, analytics workloads, and ML training. Amazon EBS Amazon EC2 instance store Amazon EFS Amazon FSx Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Choose 8 Choosing an AWS storage service AWS Decision Guide Storage type What is it optimized for? Storage services or tools Object Cache Amazon FSx for Windows File Server Amazon S3 File Gateway Amazon FSx File Gateway Amazon S3 Amazon File Cache Read-heavy workloads such as content distribution, web hosting, big data analytics, and ML workﬂows. Well-suit ed for scenarios where data needs to be stored, accessed, and distributed globally over the internet. Fully managed, scalable, and high-speed cache on AWS for processing ﬁle data stored in disparate locations—including on premises NFS ﬁle systems, and/or in cloud ﬁle systems (Amazon FSx for OpenZFS, Amazon FSx for NetApp ONTAP), and Amazon S3. Hybrid/Edge Deliver low-latency data to on-premises applications and providing on-premises applications access to cloud- backed storage. AWS Storage Gateway Tape Gateway AWS Storage Gateway Volume Gateway The following table provides a detailed look at your online and oﬄine options. Choose 9 Choosing an AWS storage service AWS Decision Guide Migration options When speed is the priority When bandwidth is important Storage services or tools AWS DataSync AWS Transfer Family Amazon FSx for NetApp ONTAP SnapMirror AWS Storage Gateway AWS Snowball Online is optimized for frequent updates Consider scheduling your transfer during to data. Use it for oﬀ hours when time-critical or you have suﬃcient ongoing workloads. bandwidth. Suitable for one-time or periodic uploads - This choice makes sense when you and when data can be need to use only the static in transit. minimum available bandwidth - and you prefer the predictab ility of physical moves. Online Oﬄine Use Now that you have determined the best protocol you need to work with your data, your performance requirements, and other criteria discussed in this guide, you should also have an understanding of which storage service would be the best ﬁt for your needs. To explore how to use and learn more about each of the available AWS storage services - we have provided a pathway to explore how each of the services work. The following section provides links to in-depth documentation, hands-on tutorials, and resources to get you started. Amazon S3 Use 10 Choosing an AWS storage service AWS Decision Guide Getting started with Amazon S3 Optimizing Amazon S3 performance This guide will help you get started with When building applications that upload and Amazon S3 by working with buckets and retrieve storage from Amazon S3, follow the objects. A bucket is a container for objects. AWS best practices guidelines in this paper An object is a ﬁle and any metadata that to optimize performance. describes that ﬁle. Explore the guide Read the whitepaper Amazon S3 tutorials The following tutorials present complete end-to-end procedures for common Amazon S3 tasks. These tutorials are intended for a lab-type environment and provide general guidance. Get started with the tutorials Amazon
storage-on-aws-how-to-choose-005	storage-on-aws-how-to-choose.pdf	5	Amazon S3 performance This guide will help you get started with When building applications that upload and Amazon S3 by working with buckets and retrieve storage from Amazon S3, follow the objects. A bucket is a container for objects. AWS best practices guidelines in this paper An object is a ﬁle and any metadata that to optimize performance. describes that ﬁle. Explore the guide Read the whitepaper Amazon S3 tutorials The following tutorials present complete end-to-end procedures for common Amazon S3 tasks. These tutorials are intended for a lab-type environment and provide general guidance. Get started with the tutorials Amazon EBS Getting started with Amazon EBS Create an Amazon EBS volume Amazon EBS is recommended for data that must be quickly accessible and requires long- term persistence. An Amazon EBS volume is a durable, block- level storage device that you can attach to your instances. Explore the guide Get started with the tutorial Use 11 Choosing an AWS storage service AWS Decision Guide Use Amazon EBS direct APIs to access the contents of an Amazon EBS snapshot You can use the direct APIs to create Amazon EBS snapshots, write and read data on your snapshots, and identify diﬀerences. Explore the guide Amazon EFS Getting started with Amazon EFS Create a Network File System Learn how to create an Amazon EFS ﬁle Learn how to store ﬁles and create an system. You will mount your ﬁle system on Amazon EFS ﬁle system, launch a Linux an Amazon EC2 instance in your VPC, and virtual machine on Amazon EC2, mount test the end-to-end setup. the ﬁle system, create a ﬁle, terminate the Get started with the tutorial instance, and delete the ﬁle system. Get started with the tutorial Set up an Apache web server and serve Amazon EFS ﬁles Learn how to set up an Apache web server on an Amazon EC2 instance and set up an Use 12 Choosing an AWS storage service AWS Decision Guide Apache web server on multiple Amazon EC2 instances by creating an Auto Scaling group. Get started with the tutorial Amazon FSx Getting started with Amazon FSx Getting started with Amazon FSx for Lustre This getting started guide walks you through what you'll need to do to begin using Learn how to use your Amazon FSx for Lustre ﬁle system to process the data in Amazon FSx. Explore the guide your Amazon S3 bucket with your ﬁle-based applications. Explore the guide What is Amazon FSx for Windows File Server? This guide provides an introduction to Amazon FSx for Windows File Server. Explore the guide Getting started with Amazon FSx for NetApp ONTAP Learn how to get started using Amazon FSx for NetApp ONTAP. Get started with the tutorial Learn how to get started with Amazon FSx for OpenZFS Use 13 Choosing an AWS storage service AWS Decision Guide This guide provides an introduction to Amazon FSx for OpenZFS. Get started with the tutorial Amazon File Cache Getting started with Amazon File Cache Amazon File Cache in action Learn how to create an Amazon File Cache resource and access it from your compute instances. This video shows how Amazon File Cache can be used as a temporary high performan ce storage location for data stored in on Get started with the tutorial premises ﬁle systems. Watch the video AWS Storage Gateway User guide for Amazon S3 File Gateway User guide for Amazon FSx File Gateway Describes Amazon S3 File Gateway concepts Describes Amazon FSx File Gateway, which and provides instructions on using the provides access to in-cloud Amazon FSx for various features with both the console and the API. Explore the guide Windows File Server shares from on-premis es facilities. Includes instructions on working with the console and the API. Explore the guide Use 14 Choosing an AWS storage service AWS Decision Guide User guide for Tape Gateway User guide for Volume Gateway Describes Tape Gateway, a durable, cost-eﬀe Describes Volume Gateway concepts, ctive tape-based solution for archiving data including details about cached and stored in the AWS cloud. Provides concepts and volume architectures, and provides instructi instructions on using the various features ons on using their features with both the with both the console and the API. console and the API. Explore the guide Explore the guide AWS DataSync Getting started with AWS DataSync Simplify multicloud data movement This guide walks through how you can get started with AWS DataSync by using the wherever data is stored with AWS DataSync AWS DataSync supports incremental AWS Management Console. transfers, integration with IAM for access Explore the guide control, and use cases like data migration , replication, and distribution across AWS Regions or accounts. Read the blog AWS DataSync tutorials These tutorials walk you through some real- world scenarios with AWS DataSync and transferring data. Get started with
storage-on-aws-how-to-choose-006	storage-on-aws-how-to-choose.pdf	6	API. console and the API. Explore the guide Explore the guide AWS DataSync Getting started with AWS DataSync Simplify multicloud data movement This guide walks through how you can get started with AWS DataSync by using the wherever data is stored with AWS DataSync AWS DataSync supports incremental AWS Management Console. transfers, integration with IAM for access Explore the guide control, and use cases like data migration , replication, and distribution across AWS Regions or accounts. Read the blog AWS DataSync tutorials These tutorials walk you through some real- world scenarios with AWS DataSync and transferring data. Get started with the tutorials Use 15 Choosing an AWS storage service AWS Transfer Family AWS Decision Guide Getting started with AWS Transfer Family AWS Transfer Family in action Learn how to create an SFTP-enabled server with publicly accessible endpoint using This video shows how the AWS Transfer Family can be used for each of the three Amazon S3 storage, add a user with service- supported protocols (SFTP, FTPS, and FTP), managed authentication, and transfer a ﬁle both over the public internet, as well as with Cyberduck. within a VPC. Get started with the tutorial Watch the video AWS Transfer Family for AS2 AWS Transfer Family SFTP Connectors Learn how to set up an Applicability Statement 2 (AS2) conﬁguration with AWS Learn how to set up an SFTP connector, and then transfer ﬁles between Amazon S3 Transfer Family. storage and an SFTP server. • Explore the guide • Explore the guide • Get started with the tutorial • Get started with the tutorial AWS Snow Family Getting started with AWS Snow Family AWS Snowball Edge developer guide Use 16 Choosing an AWS storage service AWS Decision Guide These guides provide links to documenta This guide includes guidance for local tion covering all current services in the Snow Family. storage and compute, clustering, importing and exporting data into Amazon S3, and other features of a Snowball Edge device. Explore the guide Explore the guides Explore • Developers • Solution Architects • Decision makers Architecture diagrams Whitepapers AWS Solutions Explore reference architecture Explore whitepapers to help Explore vetted solutions diagrams for containers on you get started and learn best and architectural guidance AWS. practices. for common use cases for Explore architecture diagrams Explore whitepapers containers. Explore solutions Explore 17 Choosing an AWS storage service AWS Decision Guide Document history The following table describes the important changes to this decision guide. For notiﬁcations about updates to this guide, you can subscribe to an RSS feed. Change Description Date Guide updated Guide updated June 26, 2024 April 5, 2024 Migrated to docs.aws. amazon.com, and made minor updates to Understan d, Consider, Choose, and Use sections. Added AWS Copilot, AWS Batch, and AWS Outposts. Changed capacity, orchestra tion, and provisioning to compute capacity, orchestra tion, and vertical solutions. Numerous editorial changes throughout. Initial publication Guide ﬁrst published. April 26, 2023 18
storagegateway-api-001	storagegateway-api.pdf	1	API Reference Storage Gateway API Version 2013-06-30 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Storage Gateway API Reference Storage Gateway: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Storage Gateway Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 3 ActivateGateway ........................................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 Request Parameters ................................................................................................................................ 7 Response Syntax ................................................................................................................................... 10 Response Elements ............................................................................................................................... 10 Errors ....................................................................................................................................................... 11 Examples ................................................................................................................................................. 11 See Also .................................................................................................................................................. 12 AddCache ..................................................................................................................................................... 13 Request Syntax ...................................................................................................................................... 13 Request Parameters .............................................................................................................................. 13 Response Syntax ................................................................................................................................... 14 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 Examples ................................................................................................................................................. 15 See Also .................................................................................................................................................. 15 AddTagsToResource ................................................................................................................................... 17 Request Syntax ...................................................................................................................................... 17 Request Parameters .............................................................................................................................. 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 19 See Also .................................................................................................................................................. 19 AddUploadBuﬀer ........................................................................................................................................ 20 Request Syntax ...................................................................................................................................... 20 Request Parameters .............................................................................................................................. 20 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 21 Errors ....................................................................................................................................................... 21 See Also .................................................................................................................................................. 22 AddWorkingStorage ................................................................................................................................... 23 Request Syntax ...................................................................................................................................... 23 API Version 2013-06-30 iii Storage Gateway API Reference Request Parameters .............................................................................................................................. 23 Response Syntax ................................................................................................................................... 24 Response Elements ............................................................................................................................... 24 Errors ....................................................................................................................................................... 24 Examples ................................................................................................................................................. 25 See Also .................................................................................................................................................. 26 AssignTapePool ........................................................................................................................................... 27 Request Syntax ...................................................................................................................................... 27 Request Parameters .............................................................................................................................. 27 Response Syntax ................................................................................................................................... 28 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 29 See Also .................................................................................................................................................. 29 AssociateFileSystem ................................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 Request Parameters .............................................................................................................................. 30 Response Syntax ................................................................................................................................... 33 Response Elements ............................................................................................................................... 33 Errors ....................................................................................................................................................... 33 Examples ................................................................................................................................................. 34 See Also .................................................................................................................................................. 34 AttachVolume .............................................................................................................................................. 36 Request Syntax ...................................................................................................................................... 36 Request Parameters .............................................................................................................................. 36 Response Syntax ................................................................................................................................... 38 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 38 Examples ................................................................................................................................................. 39 See Also .................................................................................................................................................. 40 CancelArchival ............................................................................................................................................. 41 Request Syntax ...................................................................................................................................... 41 Request Parameters .............................................................................................................................. 41 Response Syntax ................................................................................................................................... 42 Response Elements ............................................................................................................................... 42 Errors ....................................................................................................................................................... 42 See Also .................................................................................................................................................. 43 API Version 2013-06-30 iv Storage Gateway API Reference CancelCacheReport .................................................................................................................................... 44 Request Syntax ...................................................................................................................................... 44 Request Parameters .............................................................................................................................. 44 Response Syntax ................................................................................................................................... 44 Response Elements ............................................................................................................................... 44 Errors ....................................................................................................................................................... 45 Examples ................................................................................................................................................. 45 See Also .................................................................................................................................................. 46 CancelRetrieval ............................................................................................................................................ 47 Request Syntax ...................................................................................................................................... 47 Request Parameters .............................................................................................................................. 47 Response Syntax ................................................................................................................................... 48 Response Elements ............................................................................................................................... 48 Errors ....................................................................................................................................................... 48 See Also .................................................................................................................................................. 49 CreateCachediSCSIVolume ........................................................................................................................ 50 Request Syntax ...................................................................................................................................... 50 Request Parameters .............................................................................................................................. 51 Response Syntax ................................................................................................................................... 54 Response Elements ............................................................................................................................... 54 Errors ....................................................................................................................................................... 55 Examples ................................................................................................................................................. 55 See Also .................................................................................................................................................. 56 CreateNFSFileShare .................................................................................................................................... 57 Request Syntax ...................................................................................................................................... 57 Request Parameters .............................................................................................................................. 58 Response Syntax ................................................................................................................................... 66 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 67 Examples ................................................................................................................................................. 67 See Also .................................................................................................................................................. 70 CreateSMBFileShare ................................................................................................................................... 71 Request Syntax ...................................................................................................................................... 71 Request Parameters .............................................................................................................................. 72 Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 82 API Version 2013-06-30 v Storage Gateway API Reference Errors ....................................................................................................................................................... 82 Examples ................................................................................................................................................. 83 See Also .................................................................................................................................................. 86 CreateSnapshot ........................................................................................................................................... 87 Request Syntax ...................................................................................................................................... 87 Request Parameters .............................................................................................................................. 88 Response Syntax ................................................................................................................................... 89 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 90 Examples ................................................................................................................................................. 90 See Also .................................................................................................................................................. 91 CreateSnapshotFromVolumeRecoveryPoint ......................................................................................... 92 Request Syntax ...................................................................................................................................... 92 Request Parameters .............................................................................................................................. 92 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 95 Examples ................................................................................................................................................. 95 See Also .................................................................................................................................................. 96 CreateStorediSCSIVolume ......................................................................................................................... 97 Request Syntax ...................................................................................................................................... 97 Request Parameters .............................................................................................................................. 97 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 100 Errors ..................................................................................................................................................... 101 Examples ............................................................................................................................................... 102 See Also ................................................................................................................................................ 103 CreateTapePool ......................................................................................................................................... 104 Request Syntax .................................................................................................................................... 104 Request Parameters ........................................................................................................................... 104 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 106 Errors ..................................................................................................................................................... 106 See Also ................................................................................................................................................ 107 CreateTapes ............................................................................................................................................... 108 Request Syntax .................................................................................................................................... 108 API Version 2013-06-30 vi Storage Gateway API Reference Request Parameters ........................................................................................................................... 108 Response Syntax ................................................................................................................................. 112 Response Elements ............................................................................................................................ 112 Errors ..................................................................................................................................................... 112 Examples ............................................................................................................................................... 113 See Also ................................................................................................................................................ 113 CreateTapeWithBarcode ......................................................................................................................... 115 Request Syntax .................................................................................................................................... 115 Request Parameters ........................................................................................................................... 115 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 118 Errors ..................................................................................................................................................... 119 Examples ............................................................................................................................................... 119 See Also ................................................................................................................................................ 120 DeleteAutomaticTapeCreationPolicy .................................................................................................... 121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Syntax ................................................................................................................................. 121 Response Elements ............................................................................................................................ 121 Errors ..................................................................................................................................................... 122 Examples ............................................................................................................................................... 122 See Also ................................................................................................................................................ 123 DeleteBandwidthRateLimit .................................................................................................................... 124 Request Syntax .................................................................................................................................... 124 Request Parameters ........................................................................................................................... 124 Response Syntax ................................................................................................................................. 125 Response Elements ............................................................................................................................ 125 Errors ..................................................................................................................................................... 125 Examples ............................................................................................................................................... 126 See Also ................................................................................................................................................ 126 DeleteCacheReport .................................................................................................................................. 128 Request Syntax .................................................................................................................................... 128 Request Parameters ........................................................................................................................... 128 Response Syntax ................................................................................................................................. 128 Response Elements ............................................................................................................................ 129 Errors ..................................................................................................................................................... 129 API Version 2013-06-30 vii
storagegateway-api-002	storagegateway-api.pdf	2	................................................................................................................................. 118 Response Elements ............................................................................................................................ 118 Errors ..................................................................................................................................................... 119 Examples ............................................................................................................................................... 119 See Also ................................................................................................................................................ 120 DeleteAutomaticTapeCreationPolicy .................................................................................................... 121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Syntax ................................................................................................................................. 121 Response Elements ............................................................................................................................ 121 Errors ..................................................................................................................................................... 122 Examples ............................................................................................................................................... 122 See Also ................................................................................................................................................ 123 DeleteBandwidthRateLimit .................................................................................................................... 124 Request Syntax .................................................................................................................................... 124 Request Parameters ........................................................................................................................... 124 Response Syntax ................................................................................................................................. 125 Response Elements ............................................................................................................................ 125 Errors ..................................................................................................................................................... 125 Examples ............................................................................................................................................... 126 See Also ................................................................................................................................................ 126 DeleteCacheReport .................................................................................................................................. 128 Request Syntax .................................................................................................................................... 128 Request Parameters ........................................................................................................................... 128 Response Syntax ................................................................................................................................. 128 Response Elements ............................................................................................................................ 129 Errors ..................................................................................................................................................... 129 API Version 2013-06-30 vii Storage Gateway API Reference Examples ............................................................................................................................................... 129 See Also ................................................................................................................................................ 130 DeleteChapCredentials ............................................................................................................................ 132 Request Syntax .................................................................................................................................... 132 Request Parameters ........................................................................................................................... 132 Response Syntax ................................................................................................................................. 133 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 133 Examples ............................................................................................................................................... 134 See Also ................................................................................................................................................ 135 DeleteFileShare ......................................................................................................................................... 136 Request Syntax .................................................................................................................................... 136 Request Parameters ........................................................................................................................... 136 Response Syntax ................................................................................................................................. 136 Response Elements ............................................................................................................................ 137 Errors ..................................................................................................................................................... 137 Examples ............................................................................................................................................... 137 See Also ................................................................................................................................................ 138 DeleteGateway .......................................................................................................................................... 139 Request Syntax .................................................................................................................................... 139 Request Parameters ........................................................................................................................... 139 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 140 Examples ............................................................................................................................................... 141 See Also ................................................................................................................................................ 141 DeleteSnapshotSchedule ........................................................................................................................ 143 Request Syntax .................................................................................................................................... 143 Request Parameters ........................................................................................................................... 143 Response Syntax ................................................................................................................................. 144 Response Elements ............................................................................................................................ 144 Errors ..................................................................................................................................................... 144 Examples ............................................................................................................................................... 145 See Also ................................................................................................................................................ 145 DeleteTape ................................................................................................................................................. 147 Request Syntax .................................................................................................................................... 147 API Version 2013-06-30 viii Storage Gateway API Reference Request Parameters ........................................................................................................................... 147 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 148 Errors ..................................................................................................................................................... 148 Examples ............................................................................................................................................... 149 See Also ................................................................................................................................................ 149 DeleteTapeArchive ................................................................................................................................... 151 Request Syntax .................................................................................................................................... 151 Request Parameters ........................................................................................................................... 151 Response Syntax ................................................................................................................................. 152 Response Elements ............................................................................................................................ 152 Errors ..................................................................................................................................................... 152 See Also ................................................................................................................................................ 153 DeleteTapePool ......................................................................................................................................... 154 Request Syntax .................................................................................................................................... 154 Request Parameters ........................................................................................................................... 154 Response Syntax ................................................................................................................................. 154 Response Elements ............................................................................................................................ 154 Errors ..................................................................................................................................................... 155 See Also ................................................................................................................................................ 155 DeleteVolume ........................................................................................................................................... 157 Request Syntax .................................................................................................................................... 157 Request Parameters ........................................................................................................................... 157 Response Syntax ................................................................................................................................. 158 Response Elements ............................................................................................................................ 158 Errors ..................................................................................................................................................... 158 Examples ............................................................................................................................................... 159 See Also ................................................................................................................................................ 159 DescribeAvailabilityMonitorTest ............................................................................................................ 161 Request Syntax .................................................................................................................................... 161 Request Parameters ........................................................................................................................... 161 Response Syntax ................................................................................................................................. 161 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 162 See Also ................................................................................................................................................ 163 DescribeBandwidthRateLimit ................................................................................................................. 164 API Version 2013-06-30 ix Storage Gateway API Reference Request Syntax .................................................................................................................................... 164 Request Parameters ........................................................................................................................... 164 Response Syntax ................................................................................................................................. 164 Response Elements ............................................................................................................................ 165 Errors ..................................................................................................................................................... 165 Examples ............................................................................................................................................... 166 See Also ................................................................................................................................................ 167 DescribeBandwidthRateLimitSchedule ................................................................................................ 168 Request Syntax .................................................................................................................................... 168 Request Parameters ........................................................................................................................... 168 Response Syntax ................................................................................................................................. 169 Response Elements ............................................................................................................................ 169 Errors ..................................................................................................................................................... 170 See Also ................................................................................................................................................ 170 DescribeCache ........................................................................................................................................... 171 Request Syntax .................................................................................................................................... 171 Request Parameters ........................................................................................................................... 171 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 172 Errors ..................................................................................................................................................... 173 Examples ............................................................................................................................................... 173 See Also ................................................................................................................................................ 174 DescribeCachediSCSIVolumes ................................................................................................................ 176 Request Syntax .................................................................................................................................... 176 Request Parameters ........................................................................................................................... 176 Response Syntax ................................................................................................................................. 176 Response Elements ............................................................................................................................ 177 Errors ..................................................................................................................................................... 177 Examples ............................................................................................................................................... 178 See Also ................................................................................................................................................ 179 DescribeCacheReport .............................................................................................................................. 181 Request Syntax .................................................................................................................................... 181 Request Parameters ........................................................................................................................... 181 Response Syntax ................................................................................................................................. 181 Response Elements ............................................................................................................................ 182 Errors ..................................................................................................................................................... 182 API Version 2013-06-30 x Storage Gateway API Reference Examples ............................................................................................................................................... 183 See Also ................................................................................................................................................ 184 DescribeChapCredentials ........................................................................................................................ 185 Request Syntax .................................................................................................................................... 185 Request Parameters ........................................................................................................................... 185 Response Syntax ................................................................................................................................. 185 Response Elements ............................................................................................................................ 186 Errors ..................................................................................................................................................... 186 Examples ............................................................................................................................................... 187 See Also ................................................................................................................................................ 187 DescribeFileSystemAssociations ............................................................................................................ 189 Request Syntax .................................................................................................................................... 189 Request Parameters ........................................................................................................................... 189 Response Syntax ................................................................................................................................. 189 Response Elements ............................................................................................................................ 190 Errors ..................................................................................................................................................... 190 Examples ............................................................................................................................................... 191 See Also ................................................................................................................................................ 192 DescribeGatewayInformation ................................................................................................................ 193 Request Syntax .................................................................................................................................... 193 Request Parameters ........................................................................................................................... 193 Response Syntax ................................................................................................................................. 193 Response Elements ............................................................................................................................ 194 Errors ..................................................................................................................................................... 198 Examples ............................................................................................................................................... 199 See Also ................................................................................................................................................ 200 DescribeMaintenanceStartTime ............................................................................................................ 201 Request Syntax .................................................................................................................................... 201 Request Parameters ........................................................................................................................... 201 Response Syntax ................................................................................................................................. 201 Response Elements ............................................................................................................................ 202 Errors ..................................................................................................................................................... 203 Examples ............................................................................................................................................... 204 See Also ................................................................................................................................................ 205 DescribeNFSFileShares ............................................................................................................................ 206 Request Syntax .................................................................................................................................... 206 API Version 2013-06-30 xi Storage Gateway API Reference Request Parameters ........................................................................................................................... 206 Response Syntax ................................................................................................................................. 206 Response Elements ............................................................................................................................ 207 Errors ..................................................................................................................................................... 208 Examples ............................................................................................................................................... 208 See Also ................................................................................................................................................ 209 DescribeSMBFileShares ........................................................................................................................... 211 Request Syntax .................................................................................................................................... 211 Request Parameters ........................................................................................................................... 211 Response Syntax ................................................................................................................................. 211 Response Elements ............................................................................................................................ 212 Errors ..................................................................................................................................................... 213 Examples ............................................................................................................................................... 213 See Also ................................................................................................................................................ 214 DescribeSMBSettings ............................................................................................................................... 216 Request Syntax .................................................................................................................................... 216 Request Parameters ........................................................................................................................... 216 Response Syntax ................................................................................................................................. 216 Response Elements ............................................................................................................................ 217 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 DescribeSnapshotSchedule .................................................................................................................... 221 Request Syntax .................................................................................................................................... 221 Request Parameters ........................................................................................................................... 221 Response Syntax ................................................................................................................................. 221 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 223 Examples ............................................................................................................................................... 223 See Also ................................................................................................................................................ 224 DescribeStorediSCSIVolumes ................................................................................................................. 226 Request Syntax .................................................................................................................................... 226 Request Parameters ........................................................................................................................... 226 Response Syntax ................................................................................................................................. 226 Response Elements ............................................................................................................................ 227 Errors ..................................................................................................................................................... 228 Examples ............................................................................................................................................... 229 API Version 2013-06-30 xii Storage Gateway API Reference See
storagegateway-api-003	storagegateway-api.pdf	3	212 Errors ..................................................................................................................................................... 213 Examples ............................................................................................................................................... 213 See Also ................................................................................................................................................ 214 DescribeSMBSettings ............................................................................................................................... 216 Request Syntax .................................................................................................................................... 216 Request Parameters ........................................................................................................................... 216 Response Syntax ................................................................................................................................. 216 Response Elements ............................................................................................................................ 217 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 DescribeSnapshotSchedule .................................................................................................................... 221 Request Syntax .................................................................................................................................... 221 Request Parameters ........................................................................................................................... 221 Response Syntax ................................................................................................................................. 221 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 223 Examples ............................................................................................................................................... 223 See Also ................................................................................................................................................ 224 DescribeStorediSCSIVolumes ................................................................................................................. 226 Request Syntax .................................................................................................................................... 226 Request Parameters ........................................................................................................................... 226 Response Syntax ................................................................................................................................. 226 Response Elements ............................................................................................................................ 227 Errors ..................................................................................................................................................... 228 Examples ............................................................................................................................................... 229 API Version 2013-06-30 xii Storage Gateway API Reference See Also ................................................................................................................................................ 230 DescribeTapeArchives .............................................................................................................................. 231 Request Syntax .................................................................................................................................... 231 Request Parameters ........................................................................................................................... 231 Response Syntax ................................................................................................................................. 232 Response Elements ............................................................................................................................ 232 Errors ..................................................................................................................................................... 233 Examples ............................................................................................................................................... 234 See Also ................................................................................................................................................ 235 DescribeTapeRecoveryPoints ................................................................................................................. 236 Request Syntax .................................................................................................................................... 236 Request Parameters ........................................................................................................................... 236 Response Syntax ................................................................................................................................. 237 Response Elements ............................................................................................................................ 237 Errors ..................................................................................................................................................... 238 See Also ................................................................................................................................................ 238 DescribeTapes ........................................................................................................................................... 240 Request Syntax .................................................................................................................................... 240 Request Parameters ........................................................................................................................... 240 Response Syntax ................................................................................................................................. 241 Response Elements ............................................................................................................................ 242 Errors ..................................................................................................................................................... 242 Examples ............................................................................................................................................... 243 See Also ................................................................................................................................................ 244 DescribeUploadBuﬀer ............................................................................................................................. 245 Request Syntax .................................................................................................................................... 245 Request Parameters ........................................................................................................................... 245 Response Syntax ................................................................................................................................. 245 Response Elements ............................................................................................................................ 246 Errors ..................................................................................................................................................... 246 Examples ............................................................................................................................................... 247 See Also ................................................................................................................................................ 248 DescribeVTLDevices ................................................................................................................................. 249 Request Syntax .................................................................................................................................... 249 Request Parameters ........................................................................................................................... 249 Response Syntax ................................................................................................................................. 250 API Version 2013-06-30 xiii Storage Gateway API Reference Response Elements ............................................................................................................................ 251 Errors ..................................................................................................................................................... 251 Examples ............................................................................................................................................... 252 See Also ................................................................................................................................................ 254 DescribeWorkingStorage ........................................................................................................................ 255 Request Syntax .................................................................................................................................... 255 Request Parameters ........................................................................................................................... 255 Response Syntax ................................................................................................................................. 256 Response Elements ............................................................................................................................ 256 Errors ..................................................................................................................................................... 257 Examples ............................................................................................................................................... 257 See Also ................................................................................................................................................ 258 DetachVolume ........................................................................................................................................... 259 Request Syntax .................................................................................................................................... 259 Request Parameters ........................................................................................................................... 259 Response Syntax ................................................................................................................................. 260 Response Elements ............................................................................................................................ 260 Errors ..................................................................................................................................................... 260 Examples ............................................................................................................................................... 261 See Also ................................................................................................................................................ 261 DisableGateway ........................................................................................................................................ 263 Request Syntax .................................................................................................................................... 263 Request Parameters ........................................................................................................................... 263 Response Syntax ................................................................................................................................. 263 Response Elements ............................................................................................................................ 264 Errors ..................................................................................................................................................... 264 See Also ................................................................................................................................................ 264 DisassociateFileSystem ............................................................................................................................ 266 Request Syntax .................................................................................................................................... 266 Request Parameters ........................................................................................................................... 266 Response Syntax ................................................................................................................................. 267 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... 267 See Also ................................................................................................................................................ 267 EvictFilesFailingUpload ........................................................................................................................... 269 Request Syntax .................................................................................................................................... 269 API Version 2013-06-30 xiv Storage Gateway API Reference Request Parameters ........................................................................................................................... 269 Response Syntax ................................................................................................................................. 270 Response Elements ............................................................................................................................ 270 Errors ..................................................................................................................................................... 271 See Also ................................................................................................................................................ 271 JoinDomain ................................................................................................................................................ 272 Request Syntax .................................................................................................................................... 272 Request Parameters ........................................................................................................................... 272 Response Syntax ................................................................................................................................. 274 Response Elements ............................................................................................................................ 274 Errors ..................................................................................................................................................... 276 See Also ................................................................................................................................................ 276 ListAutomaticTapeCreationPolicies ...................................................................................................... 277 Request Syntax .................................................................................................................................... 277 Request Parameters ........................................................................................................................... 277 Response Syntax ................................................................................................................................. 277 Response Elements ............................................................................................................................ 278 Errors ..................................................................................................................................................... 278 Examples ............................................................................................................................................... 279 See Also ................................................................................................................................................ 279 ListCacheReports ...................................................................................................................................... 281 Request Syntax .................................................................................................................................... 281 Request Parameters ........................................................................................................................... 281 Response Syntax ................................................................................................................................. 281 Response Elements ............................................................................................................................ 282 Errors ..................................................................................................................................................... 283 Examples ............................................................................................................................................... 283 See Also ................................................................................................................................................ 284 ListFileShares ............................................................................................................................................ 286 Request Syntax .................................................................................................................................... 286 Request Parameters ........................................................................................................................... 286 Response Syntax ................................................................................................................................. 287 Response Elements ............................................................................................................................ 287 Errors ..................................................................................................................................................... 288 Examples ............................................................................................................................................... 288 See Also ................................................................................................................................................ 289 API Version 2013-06-30 xv Storage Gateway API Reference ListFileSystemAssociations ..................................................................................................................... 290 Request Syntax .................................................................................................................................... 290 Request Parameters ........................................................................................................................... 290 Response Syntax ................................................................................................................................. 291 Response Elements ............................................................................................................................ 291 Errors ..................................................................................................................................................... 292 See Also ................................................................................................................................................ 292 ListGateways ............................................................................................................................................. 294 Request Syntax .................................................................................................................................... 294 Request Parameters ........................................................................................................................... 294 Response Syntax ................................................................................................................................. 295 Response Elements ............................................................................................................................ 295 Errors ..................................................................................................................................................... 296 Examples ............................................................................................................................................... 296 See Also ................................................................................................................................................ 297 ListLocalDisks ............................................................................................................................................ 298 Request Syntax .................................................................................................................................... 298 Request Parameters ........................................................................................................................... 298 Response Syntax ................................................................................................................................. 298 Response Elements ............................................................................................................................ 299 Errors ..................................................................................................................................................... 299 Examples ............................................................................................................................................... 300 See Also ................................................................................................................................................ 301 ListTagsForResource ................................................................................................................................ 302 Request Syntax .................................................................................................................................... 302 Request Parameters ........................................................................................................................... 302 Response Syntax ................................................................................................................................. 303 Response Elements ............................................................................................................................ 303 Errors ..................................................................................................................................................... 304 See Also ................................................................................................................................................ 304 ListTapePools ............................................................................................................................................ 305 Request Syntax .................................................................................................................................... 305 Request Parameters ........................................................................................................................... 305 Response Syntax ................................................................................................................................. 306 Response Elements ............................................................................................................................ 306 Errors ..................................................................................................................................................... 307 API Version 2013-06-30 xvi Storage Gateway API Reference See Also ................................................................................................................................................ 307 ListTapes .................................................................................................................................................... 309 Request Syntax .................................................................................................................................... 309 Request Parameters ........................................................................................................................... 309 Response Syntax ................................................................................................................................. 310 Response Elements ............................................................................................................................ 310 Errors ..................................................................................................................................................... 311 Examples ............................................................................................................................................... 311 See Also ................................................................................................................................................ 313 ListVolumeInitiators ................................................................................................................................. 314 Request Syntax .................................................................................................................................... 314 Request Parameters ........................................................................................................................... 314 Response Syntax ................................................................................................................................. 314 Response Elements ............................................................................................................................ 315 Errors ..................................................................................................................................................... 315 See Also ................................................................................................................................................ 315 ListVolumeRecoveryPoints ..................................................................................................................... 317 Request Syntax .................................................................................................................................... 317 Request Parameters ........................................................................................................................... 317 Response Syntax ................................................................................................................................. 317 Response Elements ............................................................................................................................ 318 Errors ..................................................................................................................................................... 318 Examples ............................................................................................................................................... 319 See Also ................................................................................................................................................ 320 ListVolumes ............................................................................................................................................... 321 Request Syntax .................................................................................................................................... 321 Request Parameters ........................................................................................................................... 321 Response Syntax ................................................................................................................................. 322 Response Elements ............................................................................................................................ 322 Errors ..................................................................................................................................................... 323 Examples ............................................................................................................................................... 324 See Also ................................................................................................................................................ 325 NotifyWhenUploaded .............................................................................................................................. 326 Request Syntax .................................................................................................................................... 326 Request Parameters ........................................................................................................................... 326 Response Syntax ................................................................................................................................. 326 API Version 2013-06-30 xvii Storage Gateway API Reference Response Elements
storagegateway-api-004	storagegateway-api.pdf	4	........................................................................................................................... 314 Response Syntax ................................................................................................................................. 314 Response Elements ............................................................................................................................ 315 Errors ..................................................................................................................................................... 315 See Also ................................................................................................................................................ 315 ListVolumeRecoveryPoints ..................................................................................................................... 317 Request Syntax .................................................................................................................................... 317 Request Parameters ........................................................................................................................... 317 Response Syntax ................................................................................................................................. 317 Response Elements ............................................................................................................................ 318 Errors ..................................................................................................................................................... 318 Examples ............................................................................................................................................... 319 See Also ................................................................................................................................................ 320 ListVolumes ............................................................................................................................................... 321 Request Syntax .................................................................................................................................... 321 Request Parameters ........................................................................................................................... 321 Response Syntax ................................................................................................................................. 322 Response Elements ............................................................................................................................ 322 Errors ..................................................................................................................................................... 323 Examples ............................................................................................................................................... 324 See Also ................................................................................................................................................ 325 NotifyWhenUploaded .............................................................................................................................. 326 Request Syntax .................................................................................................................................... 326 Request Parameters ........................................................................................................................... 326 Response Syntax ................................................................................................................................. 326 API Version 2013-06-30 xvii Storage Gateway API Reference Response Elements ............................................................................................................................ 327 Errors ..................................................................................................................................................... 327 See Also ................................................................................................................................................ 328 RefreshCache ............................................................................................................................................. 329 Request Syntax .................................................................................................................................... 330 Request Parameters ........................................................................................................................... 330 Response Syntax ................................................................................................................................. 331 Response Elements ............................................................................................................................ 331 Errors ..................................................................................................................................................... 332 See Also ................................................................................................................................................ 332 RemoveTagsFromResource ..................................................................................................................... 333 Request Syntax .................................................................................................................................... 333 Request Parameters ........................................................................................................................... 333 Response Syntax ................................................................................................................................. 334 Response Elements ............................................................................................................................ 334 Errors ..................................................................................................................................................... 334 See Also ................................................................................................................................................ 334 ResetCache ................................................................................................................................................ 336 Request Syntax .................................................................................................................................... 336 Request Parameters ........................................................................................................................... 336 Response Syntax ................................................................................................................................. 337 Response Elements ............................................................................................................................ 337 Errors ..................................................................................................................................................... 337 See Also ................................................................................................................................................ 338 RetrieveTapeArchive ................................................................................................................................ 339 Request Syntax .................................................................................................................................... 339 Request Parameters ........................................................................................................................... 339 Response Syntax ................................................................................................................................. 340 Response Elements ............................................................................................................................ 340 Errors ..................................................................................................................................................... 340 Examples ............................................................................................................................................... 341 See Also ................................................................................................................................................ 341 RetrieveTapeRecoveryPoint .................................................................................................................... 343 Request Syntax .................................................................................................................................... 343 Request Parameters ........................................................................................................................... 343 Response Syntax ................................................................................................................................. 344 API Version 2013-06-30 xviii Storage Gateway API Reference Response Elements ............................................................................................................................ 344 Errors ..................................................................................................................................................... 344 See Also ................................................................................................................................................ 345 SetLocalConsolePassword ...................................................................................................................... 346 Request Syntax .................................................................................................................................... 346 Request Parameters ........................................................................................................................... 346 Response Syntax ................................................................................................................................. 347 Response Elements ............................................................................................................................ 347 Errors ..................................................................................................................................................... 347 See Also ................................................................................................................................................ 348 SetSMBGuestPassword ............................................................................................................................ 349 Request Syntax .................................................................................................................................... 349 Request Parameters ........................................................................................................................... 349 Response Syntax ................................................................................................................................. 350 Response Elements ............................................................................................................................ 350 Errors ..................................................................................................................................................... 350 See Also ................................................................................................................................................ 351 ShutdownGateway ................................................................................................................................... 352 Request Syntax .................................................................................................................................... 352 Request Parameters ........................................................................................................................... 353 Response Syntax ................................................................................................................................. 353 Response Elements ............................................................................................................................ 353 Errors ..................................................................................................................................................... 354 Examples ............................................................................................................................................... 354 See Also ................................................................................................................................................ 355 StartAvailabilityMonitorTest .................................................................................................................. 356 Request Syntax .................................................................................................................................... 356 Request Parameters ........................................................................................................................... 356 Response Syntax ................................................................................................................................. 356 Response Elements ............................................................................................................................ 357 Errors ..................................................................................................................................................... 357 See Also ................................................................................................................................................ 357 StartCacheReport ..................................................................................................................................... 359 Request Syntax .................................................................................................................................... 359 Request Parameters ........................................................................................................................... 360 Response Syntax ................................................................................................................................. 362 API Version 2013-06-30 xix Storage Gateway API Reference Response Elements ............................................................................................................................ 363 Errors ..................................................................................................................................................... 363 Examples ............................................................................................................................................... 363 See Also ................................................................................................................................................ 364 StartGateway ............................................................................................................................................ 366 Request Syntax .................................................................................................................................... 366 Request Parameters ........................................................................................................................... 366 Response Syntax ................................................................................................................................. 367 Response Elements ............................................................................................................................ 367 Errors ..................................................................................................................................................... 367 Examples ............................................................................................................................................... 368 See Also ................................................................................................................................................ 368 UpdateAutomaticTapeCreationPolicy .................................................................................................. 370 Request Syntax .................................................................................................................................... 370 Request Parameters ........................................................................................................................... 370 Response Syntax ................................................................................................................................. 371 Response Elements ............................................................................................................................ 371 Errors ..................................................................................................................................................... 371 See Also ................................................................................................................................................ 372 UpdateBandwidthRateLimit ................................................................................................................... 373 Request Syntax .................................................................................................................................... 373 Request Parameters ........................................................................................................................... 373 Response Syntax ................................................................................................................................. 374 Response Elements ............................................................................................................................ 374 Errors ..................................................................................................................................................... 374 Examples ............................................................................................................................................... 375 See Also ................................................................................................................................................ 376 UpdateBandwidthRateLimitSchedule .................................................................................................. 377 Request Syntax .................................................................................................................................... 377 Request Parameters ........................................................................................................................... 377 Response Syntax ................................................................................................................................. 378 Response Elements ............................................................................................................................ 378 Errors ..................................................................................................................................................... 378 See Also ................................................................................................................................................ 379 UpdateChapCredentials .......................................................................................................................... 380 Request Syntax .................................................................................................................................... 380 API Version 2013-06-30 xx Storage Gateway API Reference Request Parameters ........................................................................................................................... 380 Response Syntax ................................................................................................................................. 382 Response Elements ............................................................................................................................ 382 Errors ..................................................................................................................................................... 382 Examples ............................................................................................................................................... 383 See Also ................................................................................................................................................ 384 UpdateFileSystemAssociation ................................................................................................................ 385 Request Syntax .................................................................................................................................... 385 Request Parameters ........................................................................................................................... 385 Response Syntax ................................................................................................................................. 386 Response Elements ............................................................................................................................ 386 Errors ..................................................................................................................................................... 387 See Also ................................................................................................................................................ 387 UpdateGatewayInformation .................................................................................................................. 389 Request Syntax .................................................................................................................................... 389 Request Parameters ........................................................................................................................... 389 Response Syntax ................................................................................................................................. 391 Response Elements ............................................................................................................................ 391 Errors ..................................................................................................................................................... 391 Examples ............................................................................................................................................... 392 See Also ................................................................................................................................................ 392 UpdateGatewaySoftwareNow ............................................................................................................... 394 Request Syntax .................................................................................................................................... 394 Request Parameters ........................................................................................................................... 394 Response Syntax ................................................................................................................................. 395 Response Elements ............................................................................................................................ 395 Errors ..................................................................................................................................................... 395 Examples ............................................................................................................................................... 396 See Also ................................................................................................................................................ 396 UpdateMaintenanceStartTime ............................................................................................................... 398 Request Syntax .................................................................................................................................... 398 Request Parameters ........................................................................................................................... 398 Response Syntax ................................................................................................................................. 400 Response Elements ............................................................................................................................ 400 Errors ..................................................................................................................................................... 401 Examples ............................................................................................................................................... 401 API Version 2013-06-30 xxi Storage Gateway API Reference See Also ................................................................................................................................................ 402 UpdateNFSFileShare ................................................................................................................................ 403 Request Syntax .................................................................................................................................... 403 Request Parameters ........................................................................................................................... 404 Response Syntax ................................................................................................................................. 409 Response Elements ............................................................................................................................ 410 Errors ..................................................................................................................................................... 410 Examples ............................................................................................................................................... 410 See Also ................................................................................................................................................ 413 UpdateSMBFileShare ............................................................................................................................... 414 Request Syntax .................................................................................................................................... 414 Request Parameters ........................................................................................................................... 415 Response Syntax ................................................................................................................................. 422 Response Elements ............................................................................................................................ 422 Errors ..................................................................................................................................................... 422 Examples ............................................................................................................................................... 423 See Also ................................................................................................................................................ 425 UpdateSMBFileShareVisibility ................................................................................................................ 427 Request Syntax .................................................................................................................................... 427 Request Parameters ........................................................................................................................... 427 Response Syntax ................................................................................................................................. 427 Response Elements ............................................................................................................................ 428 Errors ..................................................................................................................................................... 428 See Also ................................................................................................................................................ 428 UpdateSMBLocalGroups ......................................................................................................................... 430 Request Syntax .................................................................................................................................... 430 Request Parameters ........................................................................................................................... 430 Response Syntax ................................................................................................................................. 431 Response Elements ............................................................................................................................ 431 Errors ..................................................................................................................................................... 431 See Also ................................................................................................................................................ 432 UpdateSMBSecurityStrategy .................................................................................................................. 433 Request Syntax .................................................................................................................................... 433 Request Parameters ........................................................................................................................... 433 Response Syntax ................................................................................................................................. 434 Response Elements ............................................................................................................................ 434 API Version 2013-06-30 xxii Storage Gateway API Reference Errors
storagegateway-api-005	storagegateway-api.pdf	5	........................................................................................................................... 415 Response Syntax ................................................................................................................................. 422 Response Elements ............................................................................................................................ 422 Errors ..................................................................................................................................................... 422 Examples ............................................................................................................................................... 423 See Also ................................................................................................................................................ 425 UpdateSMBFileShareVisibility ................................................................................................................ 427 Request Syntax .................................................................................................................................... 427 Request Parameters ........................................................................................................................... 427 Response Syntax ................................................................................................................................. 427 Response Elements ............................................................................................................................ 428 Errors ..................................................................................................................................................... 428 See Also ................................................................................................................................................ 428 UpdateSMBLocalGroups ......................................................................................................................... 430 Request Syntax .................................................................................................................................... 430 Request Parameters ........................................................................................................................... 430 Response Syntax ................................................................................................................................. 431 Response Elements ............................................................................................................................ 431 Errors ..................................................................................................................................................... 431 See Also ................................................................................................................................................ 432 UpdateSMBSecurityStrategy .................................................................................................................. 433 Request Syntax .................................................................................................................................... 433 Request Parameters ........................................................................................................................... 433 Response Syntax ................................................................................................................................. 434 Response Elements ............................................................................................................................ 434 API Version 2013-06-30 xxii Storage Gateway API Reference Errors ..................................................................................................................................................... 435 See Also ................................................................................................................................................ 435 UpdateSnapshotSchedule ...................................................................................................................... 437 Request Syntax .................................................................................................................................... 437 Request Parameters ........................................................................................................................... 437 Response Syntax ................................................................................................................................. 439 Response Elements ............................................................................................................................ 439 Errors ..................................................................................................................................................... 439 Examples ............................................................................................................................................... 440 See Also ................................................................................................................................................ 441 UpdateVTLDeviceType ............................................................................................................................ 442 Request Syntax .................................................................................................................................... 442 Request Parameters ........................................................................................................................... 442 Response Syntax ................................................................................................................................. 443 Response Elements ............................................................................................................................ 443 Errors ..................................................................................................................................................... 443 See Also ................................................................................................................................................ 443 Data Types ................................................................................................................................... 445 AutomaticTapeCreationPolicyInfo ........................................................................................................ 447 Contents ............................................................................................................................................... 447 See Also ................................................................................................................................................ 447 AutomaticTapeCreationRule .................................................................................................................. 448 Contents ............................................................................................................................................... 448 See Also ................................................................................................................................................ 449 BandwidthRateLimitInterval .................................................................................................................. 450 Contents ............................................................................................................................................... 450 See Also ................................................................................................................................................ 452 CacheAttributes ........................................................................................................................................ 453 Contents ............................................................................................................................................... 453 See Also ................................................................................................................................................ 453 CachediSCSIVolume ................................................................................................................................. 454 Contents ............................................................................................................................................... 454 See Also ................................................................................................................................................ 457 CacheReportFilter ..................................................................................................................................... 458 Contents ............................................................................................................................................... 458 See Also ................................................................................................................................................ 459 API Version 2013-06-30 xxiii Storage Gateway API Reference CacheReportInfo ....................................................................................................................................... 460 Contents ............................................................................................................................................... 460 See Also ................................................................................................................................................ 462 ChapInfo ..................................................................................................................................................... 463 Contents ............................................................................................................................................... 463 See Also ................................................................................................................................................ 464 DeviceiSCSIAttributes .............................................................................................................................. 465 Contents ............................................................................................................................................... 465 See Also ................................................................................................................................................ 466 Disk .............................................................................................................................................................. 467 Contents ............................................................................................................................................... 467 See Also ................................................................................................................................................ 468 EndpointNetworkConﬁguration ............................................................................................................ 470 Contents ............................................................................................................................................... 470 See Also ................................................................................................................................................ 470 FileShareInfo ............................................................................................................................................. 471 Contents ............................................................................................................................................... 471 See Also ................................................................................................................................................ 472 FileSystemAssociationInfo ...................................................................................................................... 473 Contents ............................................................................................................................................... 473 See Also ................................................................................................................................................ 475 FileSystemAssociationStatusDetail ....................................................................................................... 476 Contents ............................................................................................................................................... 476 See Also ................................................................................................................................................ 476 FileSystemAssociationSummary ........................................................................................................... 477 Contents ............................................................................................................................................... 477 See Also ................................................................................................................................................ 478 GatewayInfo .............................................................................................................................................. 479 Contents ............................................................................................................................................... 479 See Also ................................................................................................................................................ 481 NetworkInterface ..................................................................................................................................... 482 Contents ............................................................................................................................................... 482 See Also ................................................................................................................................................ 482 NFSFileShareDefaults .............................................................................................................................. 484 Contents ............................................................................................................................................... 484 See Also ................................................................................................................................................ 485 API Version 2013-06-30 xxiv Storage Gateway API Reference NFSFileShareInfo ...................................................................................................................................... 486 Contents ............................................................................................................................................... 486 See Also ................................................................................................................................................ 494 PoolInfo ...................................................................................................................................................... 496 Contents ............................................................................................................................................... 496 See Also ................................................................................................................................................ 497 SMBFileShareInfo ..................................................................................................................................... 498 Contents ............................................................................................................................................... 498 See Also ................................................................................................................................................ 508 SMBLocalGroups ....................................................................................................................................... 509 Contents ............................................................................................................................................... 509 See Also ................................................................................................................................................ 509 SoftwareUpdatePreferences .................................................................................................................. 510 Contents ............................................................................................................................................... 510 See Also ................................................................................................................................................ 510 StorageGatewayError .............................................................................................................................. 511 Contents ............................................................................................................................................... 511 See Also ................................................................................................................................................ 512 StorediSCSIVolume .................................................................................................................................. 513 Contents ............................................................................................................................................... 513 See Also ................................................................................................................................................ 517 Tag ............................................................................................................................................................... 518 Contents ............................................................................................................................................... 518 See Also ................................................................................................................................................ 518 Tape ............................................................................................................................................................ 519 Contents ............................................................................................................................................... 519 See Also ................................................................................................................................................ 522 TapeArchive ............................................................................................................................................... 523 Contents ............................................................................................................................................... 523 See Also ................................................................................................................................................ 526 TapeInfo ..................................................................................................................................................... 527 Contents ............................................................................................................................................... 527 See Also ................................................................................................................................................ 528 TapeRecoveryPointInfo ........................................................................................................................... 530 Contents ............................................................................................................................................... 530 See Also ................................................................................................................................................ 531 API Version 2013-06-30 xxv Storage Gateway API Reference VolumeInfo ................................................................................................................................................ 532 Contents ............................................................................................................................................... 532 See Also ................................................................................................................................................ 534 VolumeiSCSIAttributes ............................................................................................................................ 535 Contents ............................................................................................................................................... 535 See Also ................................................................................................................................................ 536 VolumeRecoveryPointInfo ...................................................................................................................... 537 Contents ............................................................................................................................................... 537 See Also ................................................................................................................................................ 538 VTLDevice .................................................................................................................................................. 539 Contents ............................................................................................................................................... 539 See Also ................................................................................................................................................ 540 Common Parameters ................................................................................................................... 541 Common Errors ............................................................................................................................ 544 API Version 2013-06-30 xxvi Storage Gateway Welcome Important API Reference Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. AWS Storage Gateway is the service that connects an on-premises software appliance with cloud- based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost eﬀective backup and rapid disaster recovery. Use the following links to get started using the AWS Storage Gateway Service API Reference: • Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway. • Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request. • Error responses: Provides reference information about Storage Gateway errors. • Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses. • Storage Gateway endpoints and quotas: Provides a list of each AWS Region and the endpoints available for use with Storage Gateway. Note Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume
storagegateway-api-006	storagegateway-api.pdf	6	Gateway errors. • Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses. • Storage Gateway endpoints and quotas: Provides a list of each AWS Region and the endpoints available for use with Storage Gateway. Note Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected. API Version 2013-06-30 1 Storage Gateway Important API Reference IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs. For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016. This document was last published on May 21, 2025. API Version 2013-06-30 2 Storage Gateway Actions The following actions are supported: • ActivateGateway • AddCache • AddTagsToResource • AddUploadBuﬀer • AddWorkingStorage • AssignTapePool • AssociateFileSystem • AttachVolume • CancelArchival • CancelCacheReport • CancelRetrieval • CreateCachediSCSIVolume • CreateNFSFileShare • CreateSMBFileShare • CreateSnapshot • CreateSnapshotFromVolumeRecoveryPoint • CreateStorediSCSIVolume • CreateTapePool • CreateTapes • CreateTapeWithBarcode • DeleteAutomaticTapeCreationPolicy • DeleteBandwidthRateLimit • DeleteCacheReport • DeleteChapCredentials • DeleteFileShare • DeleteGateway • DeleteSnapshotSchedule API Reference API Version 2013-06-30 3 Storage Gateway • DeleteTape • DeleteTapeArchive • DeleteTapePool • DeleteVolume • DescribeAvailabilityMonitorTest • DescribeBandwidthRateLimit • DescribeBandwidthRateLimitSchedule • DescribeCache • DescribeCachediSCSIVolumes • DescribeCacheReport • DescribeChapCredentials • DescribeFileSystemAssociations • DescribeGatewayInformation • DescribeMaintenanceStartTime • DescribeNFSFileShares • DescribeSMBFileShares • DescribeSMBSettings • DescribeSnapshotSchedule • DescribeStorediSCSIVolumes • DescribeTapeArchives • DescribeTapeRecoveryPoints • DescribeTapes • DescribeUploadBuﬀer • DescribeVTLDevices • DescribeWorkingStorage • DetachVolume • DisableGateway • DisassociateFileSystem • EvictFilesFailingUpload • JoinDomain API Reference API Version 2013-06-30 4 Storage Gateway API Reference • ListAutomaticTapeCreationPolicies • ListCacheReports • ListFileShares • ListFileSystemAssociations • ListGateways • ListLocalDisks • ListTagsForResource • ListTapePools • ListTapes • ListVolumeInitiators • ListVolumeRecoveryPoints • ListVolumes • NotifyWhenUploaded • RefreshCache • RemoveTagsFromResource • ResetCache • RetrieveTapeArchive • RetrieveTapeRecoveryPoint • SetLocalConsolePassword • SetSMBGuestPassword • ShutdownGateway • StartAvailabilityMonitorTest • StartCacheReport • StartGateway • UpdateAutomaticTapeCreationPolicy • UpdateBandwidthRateLimit • UpdateBandwidthRateLimitSchedule • UpdateChapCredentials • UpdateFileSystemAssociation • UpdateGatewayInformation API Version 2013-06-30 5 Storage Gateway • UpdateGatewaySoftwareNow • UpdateMaintenanceStartTime • UpdateNFSFileShare • UpdateSMBFileShare • UpdateSMBFileShareVisibility • UpdateSMBLocalGroups • UpdateSMBSecurityStrategy • UpdateSnapshotSchedule • UpdateVTLDeviceType API Reference API Version 2013-06-30 6 Storage Gateway ActivateGateway API Reference Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation. Note You must turn on the gateway VM before you can activate your gateway. Request Syntax { "ActivationKey": "string", "GatewayName": "string", "GatewayRegion": "string", "GatewayTimezone": "string", "GatewayType": "string", "MediumChangerType": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TapeDriveType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActivationKey Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the ActivateGateway API Version 2013-06-30 7 Storage Gateway API Reference response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual conﬁguration of your gateway. For more information, see Getting activation key in the Storage Gateway User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: Yes GatewayName The name you conﬁgured for your gateway. Type: String Length Constraints: Minimum length of 2. Maximum length of 255. Pattern: ^[ -\.0-\[\]-~][!-\.0-\[\]-~][ -\.0-\[\]-~]$ Required: Yes GatewayRegion A value that indicates the AWS Region where you want to store your data. The gateway AWS Region speciﬁed must be the same AWS Region as
storagegateway-api-007	storagegateway-api.pdf	7	are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual conﬁguration of your gateway. For more information, see Getting activation key in the Storage Gateway User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: Yes GatewayName The name you conﬁgured for your gateway. Type: String Length Constraints: Minimum length of 2. Maximum length of 255. Pattern: ^[ -\.0-\[\]-~][!-\.0-\[\]-~][ -\.0-\[\]-~]$ Required: Yes GatewayRegion A value that indicates the AWS Region where you want to store your data. The gateway AWS Region speciﬁed must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the AWS General Reference. Valid Values: See Storage Gateway endpoints and quotas in the AWS General Reference. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. Required: Yes GatewayTimezone A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any oﬀset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 Request Parameters API Version 2013-06-30 8 Storage Gateway API Reference indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. Type: String Length Constraints: Minimum length of 3. Maximum length of 10. Required: Yes GatewayType A value that deﬁnes the type of gateway to activate. The type speciﬁed is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED. Important Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Valid Values: STORED \| CACHED \| VTL \| FILE_S3 \| FILE_FSX_SMB Type: String Length Constraints: Minimum length of 2. Maximum length of 20. Required: No MediumChangerType The value that indicates the type of medium changer to use for tape gateway. This ﬁeld is optional. Valid Values: STK-L700 \| AWS-Gateway-VTL \| IBM-03584L32-0402 Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No Tags A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair. Request Parameters API Version 2013-06-30 9 Storage Gateway Note API Reference Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters. Type: Array of Tag objects Required: No TapeDriveType The value that indicates the type of tape drive to use for tape gateway. This ﬁeld is optional. Valid Values: IBM-ULT3580-TD5 Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Response Syntax API Version 2013-06-30 10 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Activate a gateway The following example shows a request that activates a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.ActivateGateway { "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V", "GatewayName": "mygateway", "GatewayTimezone": "GMT-12:00", Errors API Version 2013-06-30 11 Storage Gateway API Reference "GatewayRegion": "us-east-2", "GatewayType": "STORED", } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-11A2222B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python
storagegateway-api-008	storagegateway-api.pdf	8	11 Storage Gateway API Reference "GatewayRegion": "us-east-2", "GatewayType": "STORED", } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-11A2222B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 12 Storage Gateway AddCache API Reference Conﬁgures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and ﬁle gateway type (see How Storage Gateway works (architecture). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to conﬁgure as cache. Request Syntax { "DiskIds": [ "string" ], "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DiskIds An array of strings that identify disks that are to be conﬁgured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. Required: Yes GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. AddCache API Version 2013-06-30 13 API Reference Storage Gateway Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 14 Storage Gateway Examples Example request API Reference The following example shows a request that activates a stored volumes gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120425T120000Z x-amz-target: StorageGateway_20130630.AddCache { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ] } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 25 Apr 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 85 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2013-06-30 15 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 16 Storage Gateway API Reference AddTagsToResource Adds one or more tags to the speciﬁed resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you deﬁne. You can add tags to the following Storage Gateway resources: • Storage gateways of all types • Storage volumes • Virtual tapes • NFS and SMB ﬁle shares • File System associations You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The Amazon Resource Name (ARN) of the resource you want to add tags to. Type: String AddTagsToResource API Version 2013-06-30 17 Storage Gateway API Reference Length Constraints: Minimum length of 50.
storagegateway-api-009	storagegateway-api.pdf	9	System associations You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The Amazon Resource Name (ARN) of the resource you want to add tags to. Type: String AddTagsToResource API Version 2013-06-30 17 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Tags The key-value pair that represents the tag you want to add to the resource. The value can be an empty string. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: Yes Response Syntax { "ResourceARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ResourceARN The Amazon Resource Name (ARN) of the resource you want to add tags to. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Response Syntax API Version 2013-06-30 18 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 19 Storage Gateway AddUploadBuﬀer API Reference Conﬁgures one or more gateway local disks as upload buﬀer for a speciﬁed gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buﬀer, and one or more disk IDs that you want to conﬁgure as upload buﬀer. Request Syntax { "DiskIds": [ "string" ], "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DiskIds An array of strings that identify disks that are to be conﬁgured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. Required: Yes GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. AddUploadBuﬀer API Version 2013-06-30 20 API Reference Storage Gateway Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 21 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK
storagegateway-api-010	storagegateway-api.pdf	10	error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 21 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 22 Storage Gateway API Reference AddWorkingStorage Conﬁgures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuﬀer instead. Note Working storage is also referred to as upload buﬀer. You can also use the AddUploadBuﬀer operation to add upload buﬀer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to conﬁgure as working storage. Request Syntax { "DiskIds": [ "string" ], "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DiskIds An array of strings that identify disks that are to be conﬁgured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. Required: Yes AddWorkingStorage API Version 2013-06-30 23 Storage Gateway GatewayARN API Reference The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Syntax API Version 2013-06-30 24 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that speciﬁes that two local disks of a gateway are to be conﬁgured as working storage. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.AddWorkingStorage { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-1:0:0:0" ] } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { Examples API Version 2013-06-30 25 Storage Gateway API Reference "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 26 Storage Gateway AssignTapePool API Reference Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. Request Syntax { "BypassGovernanceRetention": boolean, "PoolId": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BypassGovernanceRetention Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape's archived age is not older than RetentionLockInDays, and the user does not already
storagegateway-api-011	storagegateway-api.pdf	11	pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. Request Syntax { "BypassGovernanceRetention": boolean, "PoolId": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BypassGovernanceRetention Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape's archived age is not older than RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console. Valid values: TRUE \| FALSE Type: Boolean Required: No PoolId The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. AssignTapePool API Version 2013-06-30 27 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes TapeARN The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: Yes Response Syntax { "TapeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Response Syntax API Version 2013-06-30 28 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 29 Storage Gateway API Reference AssociateFileSystem Associate an Amazon FSx ﬁle system with the FSx File Gateway. After the association process is complete, the ﬁle shares on the Amazon FSx ﬁle system are available for access through the gateway. This operation only supports the FSx File Gateway type. Request Syntax { "AuditDestinationARN": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "ClientToken": "string", "EndpointNetworkConfiguration": { "IpAddresses": [ "string" ] }, "GatewayARN": "string", "LocationARN": "string", "Password": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for the audit logs. Type: String Length Constraints: Maximum length of 1024. AssociateFileSystem API Version 2013-06-30 30 Storage Gateway Required: No CacheAttributes The refresh cache information for the ﬁle share or FSx ﬁle systems. Type: CacheAttributes object Required: No ClientToken API Reference A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent ﬁle system association creation. Type: String Length Constraints: Minimum length of 5. Maximum length of 100. Required: Yes EndpointNetworkConﬁguration Speciﬁes the network conﬁguration information for the gateway associated with the Amazon FSx ﬁle system. Note If multiple ﬁle systems are associated with this gateway, this parameter's IpAddresses ﬁeld is required. Type: EndpointNetworkConﬁguration object Required: No GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Request Parameters API Version 2013-06-30 31 Storage Gateway Required: Yes LocationARN API Reference The Amazon Resource Name (ARN) of the Amazon FSx ﬁle system to associate with the FSx File Gateway. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Required: Yes Password The password of
storagegateway-api-012	storagegateway-api.pdf	12	with this gateway, this parameter's IpAddresses ﬁeld is required. Type: EndpointNetworkConﬁguration object Required: No GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Request Parameters API Version 2013-06-30 31 Storage Gateway Required: Yes LocationARN API Reference The Amazon Resource Name (ARN) of the Amazon FSx ﬁle system to associate with the FSx File Gateway. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Required: Yes Password The password of the user credential. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[ -~]+$ Required: Yes Tags A list of up to 50 tags that can be assigned to the ﬁle system association. Each tag is a key-value pair. Type: Array of Tag objects Required: No UserName The user name of the user credential that has permission to access the root share D$ of the Amazon FSx ﬁle system. The user account must belong to the Amazon FSx delegated admin user group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Request Parameters API Version 2013-06-30 32 API Reference Storage Gateway Pattern: ^\w[\w\.\- ]*$ Required: Yes Response Syntax { "FileSystemAssociationARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileSystemAssociationARN The ARN of the newly created ﬁle system association. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 33 API Reference Storage Gateway Examples Example This example illustrates one usage of AssociateFileSystem. Sample Request __Sample Request__ { "UserName": "Admin", "Password": "Password123", "ClientToken": "foo-fsx-101", "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-7A8D6313", "LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs-0bb4bf5cedebd814f", } Example This example illustrates one usage of AssociateFileSystem. Sample Response __Sample Response__ { "FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs- association/fsa-1122AABBCCDDEEFFG"] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Examples API Version 2013-06-30 34 Storage Gateway • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 35 Storage Gateway AttachVolume API Reference Connects a volume to an iSCSI connection and then attaches the volume to the speciﬁed gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a diﬀerent gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. Request Syntax { "DiskId": "string", "GatewayARN": "string", "NetworkInterfaceId": "string", "TargetName": "string", "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DiskId The unique device ID or other distinguishing data that identiﬁes the local disk used to create the volume. This value is only required when you are attaching a stored volume. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Required: No GatewayARN The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. AttachVolume API Version 2013-06-30 36 Storage Gateway Required: Yes NetworkInterfaceId API Reference The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. 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 Required: Yes TargetName The name of the iSCSI target used by an initiator to connect to a volume and used as a suﬃx for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[-\.;a-z0-9]+$ Required: No VolumeARN The
storagegateway-api-013	storagegateway-api.pdf	13	address. 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 Required: Yes TargetName The name of the iSCSI target used by an initiator to connect to a volume and used as a suﬃx for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[-\.;a-z0-9]+$ Required: No VolumeARN The Amazon Resource Name (ARN) of the volume to attach to the speciﬁed gateway. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Request Parameters API Version 2013-06-30 37 Storage Gateway API Reference Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "TargetARN": "string", "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TargetARN The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. VolumeARN The Amazon Resource Name (ARN) of the volume that was attached to the gateway. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-06-30 38 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that attaches a volume to a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20181025T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630. AttachVolume { "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "NetworkInterfaceId": "10.1.1.1", "TargetName": "myvolume", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Examples API Version 2013-06-30 39 Storage Gateway API Reference Date: Thu, 25 Oct 2018 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 40 Storage Gateway CancelArchival API Reference Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type. Request Syntax { "GatewayARN": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes TapeARN The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: Yes CancelArchival API Version 2013-06-30 41 Storage Gateway Response Syntax { "TapeARN": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 42 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go
storagegateway-api-014	storagegateway-api.pdf	14	Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 42 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 43 Storage Gateway CancelCacheReport API Reference Cancels generation of a speciﬁed cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error. Request Syntax { "CacheReportARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CacheReportARN The Amazon Resource Name (ARN) of the cache report you want to cancel. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CacheReportARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CancelCacheReport API Version 2013-06-30 44 Storage Gateway CacheReportARN API Reference The Amazon Resource Name (ARN) of the cache report you want to cancel. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Cancel a cache report The following example cancels the cache report with the speciﬁed ARN. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-1.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.CancelCacheReport Errors API Version 2013-06-30 45 Storage Gateway { API Reference "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234/cache-report/report-ABCD1234" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234/cache-report/report-ABCD1234" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 46 Storage Gateway CancelRetrieval API Reference Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type. Request Syntax { "GatewayARN": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes TapeARN The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: Yes CancelRetrieval API Version 2013-06-30 47 Storage Gateway Response Syntax { "TapeARN": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code:
storagegateway-api-015	storagegateway-api.pdf	15	Syntax { "TapeARN": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 48 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 49 Storage Gateway API Reference CreateCachediSCSIVolume Creates a cached volume on a speciﬁed cached volume gateway. This operation is only supported in the cached volume gateway type. Note Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes. Request Syntax { "ClientToken": "string", "GatewayARN": "string", "KMSEncrypted": boolean, "KMSKey": "string", "NetworkInterfaceId": "string", "SnapshotId": "string", "SourceVolumeARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetName": "string", "VolumeSizeInBytes": number CreateCachediSCSIVolume API Version 2013-06-30 50 Storage Gateway } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken A unique identiﬁer that you use to retry a request. If you retry a request, use the same ClientToken you speciﬁed in the initial request. Type: String Length Constraints: Minimum length of 5. Maximum length of 100. Required: Yes GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes KMSEncrypted Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. Valid Values: true \| false Type: Boolean Required: No KMSKey The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional. Request Parameters API Version 2013-06-30 51 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No NetworkInterfaceId The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. 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 Required: Yes SnapshotId The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this ﬁeld if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this ﬁeld. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}\|[0-9A-Fa-f]{17})\z Required: No SourceVolumeARN The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the speciﬁed existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes. Request Parameters API Version 2013-06-30 52 Storage Gateway Type: String API Reference Length Constraints: Minimum
storagegateway-api-016	storagegateway-api.pdf	16	to create the iSCSI storage volume from a snapshot; otherwise, do not include this ﬁeld. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}\|[0-9A-Fa-f]{17})\z Required: No SourceVolumeARN The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the speciﬁed existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes. Request Parameters API Version 2013-06-30 52 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: No Tags A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters. Type: Array of Tag objects Required: No TargetName The name of the iSCSI target used by an initiator to connect to a volume and used as a suﬃx for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[-\.;a-z0-9]+$ Request Parameters API Version 2013-06-30 53 API Reference Storage Gateway Required: Yes VolumeSizeInBytes The size of the volume in bytes. Type: Long Required: Yes Response Syntax { "TargetARN": "string", "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TargetARN The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. VolumeARN The Amazon Resource Name (ARN) of the conﬁgured volume. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Response Syntax API Version 2013-06-30 54 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that speciﬁes that a local disk of a gateway be conﬁgured as a cached volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.CreateCachediSCSIVolume { "ClientToken": "cachedvol112233", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "NetworkInterfaceId": "10.1.1.1", Errors API Version 2013-06-30 55 Storage Gateway API Reference "TargetName": "myvolume", "VolumeSizeInBytes": "536870912000" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 263 { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 56 Storage Gateway CreateNFSFileShare API Reference Creates a Network File System (NFS) ﬁle share on an existing S3 File Gateway. In Storage Gateway, a ﬁle share is a ﬁle system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes ﬁle shares using an NFS interface. This operation is only supported for S3 File Gateways. Important S3 File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a ﬁle share. Make sure AWS STS is activated in the AWS Region you are creating your S3 File Gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. S3 File Gateways do not support creating hard or symbolic links on a ﬁle share. Request
storagegateway-api-017	storagegateway-api.pdf	17	supported for S3 File Gateways. Important S3 File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a ﬁle share. Make sure AWS STS is activated in the AWS Region you are creating your S3 File Gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. S3 File Gateways do not support creating hard or symbolic links on a ﬁle share. Request Syntax { "AuditDestinationARN": "string", "BucketRegion": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "ClientList": [ "string" ], "ClientToken": "string", "DefaultStorageClass": "string", "EncryptionType": "string", "FileShareName": "string", "GatewayARN": "string", "GuessMIMETypeEnabled": boolean, "KMSEncrypted": boolean, "KMSKey": "string", "LocationARN": "string", "NFSFileShareDefaults": { "DirectoryMode": "string", "FileMode": "string", "GroupId": number, "OwnerId": number }, "NotificationPolicy": "string", CreateNFSFileShare API Version 2013-06-30 57 Storage Gateway API Reference "ObjectACL": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Role": "string", "Squash": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VPCEndpointDNSName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No BucketRegion Speciﬁes the Region of the S3 bucket where the NFS ﬁle share stores ﬁles. Note This parameter is required for NFS ﬁle shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. Request Parameters API Version 2013-06-30 58 API Reference Storage Gateway Required: No CacheAttributes Speciﬁes refresh cache information for the ﬁle share. Type: CacheAttributes object Required: No ClientList The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\| [1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])(\/([0-9]\|[1-2][0-9]\|3[0-2]))?$ Required: No ClientToken A unique string value that you supply that is used by S3 File Gateway to ensure idempotent ﬁle share creation. Type: String Length Constraints: Minimum length of 5. Maximum length of 100. Required: Yes DefaultStorageClass The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values: S3_STANDARD \| S3_INTELLIGENT_TIERING \| S3_STANDARD_IA \| S3_ONEZONE_IA Type: String Request Parameters API Version 2013-06-30 59 Storage Gateway API Reference Length Constraints: Minimum length of 5. Maximum length of 50. Required: No EncryptionType A value that speciﬁes the type of server-side encryption that the ﬁle share will use for the data that it stores in Amazon S3. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Type: String Valid Values: SseS3 \| SseKms \| DsseKms Required: No FileShareName The name of the ﬁle share. Optional. Note FileShareName must be set if an S3 preﬁx name is set in LocationARN, or if an access point or access point alias is used. A valid NFS ﬁle share name can only contain the following characters: a-z, A-Z, 0-9, -, ., and _. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No Request Parameters API Version 2013-06-30 60 Storage Gateway GatewayARN API Reference The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a ﬁle share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes GuessMIMETypeEnabled A value that enables guessing of the MIME type for uploaded objects based on ﬁle extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true. Valid Values: true \| false Type: Boolean Required: No KMSEncrypted This parameter has been deprecated. Optional. Set to true to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3,
storagegateway-api-018	storagegateway-api.pdf	18	true \| false Type: Boolean Required: No KMSEncrypted This parameter has been deprecated. Optional. Set to true to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Valid Values: true \| false Request Parameters API Version 2013-06-30 61 Storage Gateway Type: Boolean Required: No KMSKey API Reference Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No LocationARN A custom ARN for the backend storage used for storing data for ﬁle shares. It includes a resource ARN with an optional preﬁx concatenation. The preﬁx must end with a forward slash (/). Note You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::amzn-s3-demo-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be conﬁgured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias Type: String Request Parameters API Version 2013-06-30 62 Storage Gateway API Reference Length Constraints: Minimum length of 16. Maximum length of 1400. Required: Yes NFSFileShareDefaults File share default values. Optional. Type: NFSFileShareDefaults object Required: No NotiﬁcationPolicy The notiﬁcation policy of the ﬁle share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a ﬁle before generating an ObjectUploaded notiﬁcation. Because clients can make many small writes to ﬁles, it's best to set this parameter for as long as possible to avoid generating multiple notiﬁcations for the same ﬁle in a small time period. Note SettlingTimeInSeconds has no eﬀect on the timing of the object uploading to Amazon S3, only the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more than the speciﬁed delay time to generate and send notiﬁcations. The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets NotificationPolicy oﬀ. {} Type: String Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: ^\{[\w\s:\{\}\[\]"]}$ Request Parameters API Version 2013-06-30 63 Storage Gateway Required: No ObjectACL API Reference A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private. Type: String Valid Values: private \| public-read \| public-read-write \| authenticated-read \| bucket-owner-read \| bucket-owner-full-control \| aws-exec-read Required: No ReadOnly A value that sets the write status of a ﬁle share. Set this value to true to set the write status to read-only, otherwise set to false. Valid Values: true \| false Type: Boolean Required: No RequesterPays A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. Note RequesterPays is a conﬁguration for the S3 bucket that backs the ﬁle share, so make sure that the conﬁguration on the ﬁle share is the same as the S3 bucket conﬁguration. Valid Values: true \| false Type: Boolean Required: No Request Parameters API Version 2013-06-30 64 Storage Gateway Role API Reference The ARN of the AWS Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S +)$ Required: Yes Squash A value that maps a user to anonymous user. Valid values are the following: • RootSquash: Only root is mapped to anonymous user. • NoSquash: No one is mapped to anonymous user. • AllSquash: Everyone is mapped to anonymous user. Type: String Length Constraints: Minimum length of 5. Maximum length of 15. Required: No Tags A list of up to 50 tags that can be assigned
storagegateway-api-019	storagegateway-api.pdf	19	Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):iam::([0-9]+):role/(\S +)$ Required: Yes Squash A value that maps a user to anonymous user. Valid values are the following: • RootSquash: Only root is mapped to anonymous user. • NoSquash: No one is mapped to anonymous user. • AllSquash: Everyone is mapped to anonymous user. Type: String Length Constraints: Minimum length of 5. Maximum length of 15. Required: No Tags A list of up to 50 tags that can be assigned to the NFS ﬁle share. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Request Parameters API Version 2013-06-30 65 Storage Gateway Required: No VPCEndpointDNSName API Reference Speciﬁes the DNS name for the VPC endpoint that the NFS ﬁle share uses to connect to Amazon S3. Note This parameter is required for NFS ﬁle shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: No Response Syntax { "FileShareARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileShareARN The Amazon Resource Name (ARN) of the newly created ﬁle share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Response Syntax API Version 2013-06-30 66 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Create an NFS ﬁle share In the following request, you create a ﬁle share using an existing S3 File Gateway and using your own AWS KMS key to perform server-side encryption of the contents of the ﬁle share. Sample Request { "ClientList": "10.1.1.1", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket", "NFSFileShareDefaults": { "FileMode": "0777", "DirectoryMode": "0777", "GroupId": "500", "OwnerId": "500" }, Errors API Version 2013-06-30 67 Storage Gateway API Reference "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "Squash": "RootSquash" } Sample Response { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Create an NFS ﬁle share with ﬁle upload notiﬁcation on In the following request, you create an NFS ﬁle share using an existing ﬁle gateway and with ﬁle upload notiﬁcation turned on and settling time set to 60 seconds. Sample Request { "ClientList": "10.1.1.1", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket", "NFSFileShareDefaults": { "FileMode": "0777", "DirectoryMode": "0777", "GroupId": "500", "OwnerId": "500" }, "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "Squash": "RootSquash", "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}" } Examples API Version 2013-06-30 68 Storage Gateway Sample Response { API Reference "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Create an NFS ﬁle share with ﬁle upload notiﬁcation oﬀ In the following request, you create an NFS ﬁle share using an existing ﬁle gateway and with ﬁle upload notiﬁcation turned oﬀ. Sample Request { "ClientList": "10.1.1.1", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket", "NFSFileShareDefaults": { "FileMode": "0777", "DirectoryMode": "0777", "GroupId": "500", "OwnerId": "500" }, "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "Squash": "RootSquash", "NotificationPolicy": "{}" } Sample Response { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Examples API Version 2013-06-30 69 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 70 Storage Gateway API Reference CreateSMBFileShare Creates a Server Message Block (SMB) ﬁle share on an existing S3 File Gateway. In Storage Gateway, a ﬁle share is a ﬁle system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes ﬁle shares using an SMB interface. This operation is only supported for S3 File Gateways. Important S3 File
storagegateway-api-020	storagegateway-api.pdf	20	Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 70 Storage Gateway API Reference CreateSMBFileShare Creates a Server Message Block (SMB) ﬁle share on an existing S3 File Gateway. In Storage Gateway, a ﬁle share is a ﬁle system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes ﬁle shares using an SMB interface. This operation is only supported for S3 File Gateways. Important S3 File Gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a ﬁle share. Make sure that AWS STS is activated in the AWS Region you are creating your S3 File Gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a ﬁle share. Request Syntax { "AccessBasedEnumeration": boolean, "AdminUserList": [ "string" ], "AuditDestinationARN": "string", "Authentication": "string", "BucketRegion": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "CaseSensitivity": "string", "ClientToken": "string", "DefaultStorageClass": "string", "EncryptionType": "string", "FileShareName": "string", "GatewayARN": "string", "GuessMIMETypeEnabled": boolean, "InvalidUserList": [ "string" ], "KMSEncrypted": boolean, "KMSKey": "string", "LocationARN": "string", "NotificationPolicy": "string", CreateSMBFileShare API Version 2013-06-30 71 Storage Gateway API Reference "ObjectACL": "string", "OplocksEnabled": boolean, "ReadOnly": boolean, "RequesterPays": boolean, "Role": "string", "SMBACLEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "ValidUserList": [ "string" ], "VPCEndpointDNSName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessBasedEnumeration The ﬁles and folders on this share will only be visible to users with read access. Type: Boolean Required: No AdminUserList A list of users or groups in the Active Directory that will be granted administrator privileges on the ﬁle share. These users can do all ﬁle operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Important Use this option very carefully, because any user in this list can do anything they like on the ﬁle share, regardless of ﬁle permissions. Type: Array of strings Request Parameters API Version 2013-06-30 72 Storage Gateway API Reference Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: No AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No Authentication The authentication method that users use to access the ﬁle share. The default is ActiveDirectory. Valid Values: ActiveDirectory \| GuestAccess Type: String Length Constraints: Minimum length of 5. Maximum length of 15. Required: No BucketRegion Speciﬁes the Region of the S3 bucket where the SMB ﬁle share stores ﬁles. Note This parameter is required for SMB ﬁle shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. Required: No Request Parameters API Version 2013-06-30 73 Storage Gateway CacheAttributes Speciﬁes refresh cache information for the ﬁle share. Type: CacheAttributes object Required: No CaseSensitivity API Reference The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified. Type: String Valid Values: ClientSpecified \| CaseSensitive Required: No ClientToken A unique string value that you supply that is used by S3 File Gateway to ensure idempotent ﬁle share creation. Type: String Length Constraints: Minimum length of 5. Maximum length of 100. Required: Yes DefaultStorageClass The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values: S3_STANDARD \| S3_INTELLIGENT_TIERING \| S3_STANDARD_IA \| S3_ONEZONE_IA Type: String Length Constraints: Minimum length of 5. Maximum length of 50. Required: No Request Parameters API Version 2013-06-30 74 Storage Gateway EncryptionType API Reference A value that speciﬁes the type of server-side encryption that the ﬁle share will use for the data that it stores in Amazon S3. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Type: String Valid Values: SseS3 \| SseKms \| DsseKms Required:
storagegateway-api-021	storagegateway-api.pdf	21	Reference A value that speciﬁes the type of server-side encryption that the ﬁle share will use for the data that it stores in Amazon S3. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Type: String Valid Values: SseS3 \| SseKms \| DsseKms Required: No FileShareName The name of the ﬁle share. Optional. Note FileShareName must be set if an S3 preﬁx name is set in LocationARN, or if an access point or access point alias is used. A valid SMB ﬁle share name cannot contain the following characters: [,],#,;,<,>,:,",\,/,\|,?,,+, or ASCII control characters 1-31. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No GatewayARN The ARN of the S3 File Gateway on which you want to create a ﬁle share. Request Parameters API Version 2013-06-30 75 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes GuessMIMETypeEnabled A value that enables guessing of the MIME type for uploaded objects based on ﬁle extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true. Valid Values: true \| false Type: Boolean Required: No InvalidUserList A list of users or groups in the Active Directory that are not allowed to access the ﬁle share. A group must be preﬁxed with the @ character. Acceptable formats include: DOMAIN \User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: No KMSEncrypted This parameter has been deprecated. Optional. Set to true to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead. Note We recommend using EncryptionType instead of KMSEncrypted to set the ﬁle share encryption method. You do not need to provide values for both parameters. Request Parameters API Version 2013-06-30 76 Storage Gateway API Reference If values for both parameters exist in the same request, then the speciﬁed encryption methods must not conﬂict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Valid Values: true \| false Type: Boolean Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No LocationARN A custom ARN for the backend storage used for storing data for ﬁle shares. It includes a resource ARN with an optional preﬁx concatenation. The preﬁx must end with a forward slash (/). Note You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::amzn-s3-demo-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ Request Parameters API Version 2013-06-30 77 Storage Gateway API Reference If you specify an access point, the bucket policy must be conﬁgured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias Type: String Length Constraints: Minimum length of 16. Maximum length of 1400. Required: Yes NotiﬁcationPolicy The notiﬁcation policy of the ﬁle share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a ﬁle before generating an ObjectUploaded notiﬁcation. Because clients can make many small writes to ﬁles, it's best to set this parameter for as long as possible to avoid generating multiple notiﬁcations for the same ﬁle in a small time period. Note SettlingTimeInSeconds has no eﬀect on the timing of the object uploading to Amazon S3, only the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more than the speciﬁed delay time to generate and send notiﬁcations. The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets NotificationPolicy oﬀ. {} Type: String Request Parameters API Version 2013-06-30 78 Storage Gateway API Reference Length Constraints: Minimum
storagegateway-api-022	storagegateway-api.pdf	22	the same ﬁle in a small time period. Note SettlingTimeInSeconds has no eﬀect on the timing of the object uploading to Amazon S3, only the timing of the notiﬁcation. This setting is not meant to specify an exact time at which the notiﬁcation will be sent. In some cases, the gateway might require more than the speciﬁed delay time to generate and send notiﬁcations. The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets NotificationPolicy oﬀ. {} Type: String Request Parameters API Version 2013-06-30 78 Storage Gateway API Reference Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: ^\{[\w\s:\{\}\[\]"]}$ Required: No ObjectACL A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private. Type: String Valid Values: private \| public-read \| public-read-write \| authenticated-read \| bucket-owner-read \| bucket-owner-full-control \| aws-exec-read Required: No OplocksEnabled Speciﬁes whether opportunistic locking is enabled for the SMB ﬁle share. Note Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to ﬁles with the same name in diﬀerent case. Valid Values: true \| false Type: Boolean Required: No ReadOnly A value that sets the write status of a ﬁle share. Set this value to true to set the write status to read-only, otherwise set to false. Valid Values: true \| false Type: Boolean Required: No Request Parameters API Version 2013-06-30 79 Storage Gateway RequesterPays API Reference A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. Note RequesterPays is a conﬁguration for the S3 bucket that backs the ﬁle share, so make sure that the conﬁguration on the ﬁle share is the same as the S3 bucket conﬁguration. Valid Values: true \| false Type: Boolean Required: No Role The ARN of the AWS Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):iam::([0-9]+):role/(\S +)$ Required: Yes SMBACLEnabled Set this value to true to enable access control list (ACL) on the SMB ﬁle share. Set it to false to map ﬁle and directory permissions to the POSIX permissions. For more information, see Using Windows ACLs to limit SMB ﬁle share access in the Amazon S3 File Gateway User Guide. Valid Values: true \| false Type: Boolean Request Parameters API Version 2013-06-30 80 Storage Gateway Required: No Tags API Reference A list of up to 50 tags that can be assigned to the NFS ﬁle share. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No ValidUserList A list of users or groups in the Active Directory that are allowed to access the ﬁle share. A group must be preﬁxed with the @ character. Acceptable formats include: DOMAIN \User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: No VPCEndpointDNSName Speciﬁes the DNS name for the VPC endpoint that the SMB ﬁle share uses to connect to Amazon S3. Note This parameter is required for SMB ﬁle shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point. Type: String Request Parameters API Version 2013-06-30 81 Storage Gateway API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-]*[A-Za-z0-9])$ Required: No Response Syntax { "FileShareARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileShareARN The Amazon Resource Name (ARN) of the newly created ﬁle share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service.
storagegateway-api-023	storagegateway-api.pdf	23	If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileShareARN The Amazon Resource Name (ARN) of the newly created ﬁle share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. Response Syntax API Version 2013-06-30 82 Storage Gateway HTTP Status Code: 400 Examples Create an SMB ﬁle share API Reference In the following request, you create an SMB ﬁle share using an existing S3 File Gateway and using your own AWS KMS key to perform server-side encryption of the contents of the ﬁle share. Sample Request { "Authentication": "ActiveDirectory", "CacheAttributes": { "CacheStaleTimeoutInSeconds": 300 }, "CaseSensitivity": "ClientSpecified", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "FileShareName": "my-file-share", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "InvalidList": [ "user1", "user3", "@group2" ], "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/", "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ValidUserList": [ "user2", "@group1" ] } Examples API Version 2013-06-30 83 Storage Gateway Sample Response { API Reference "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Create an SMB ﬁle share with ﬁle upload notiﬁcation on In the following request, you create an SMB ﬁle share using an existing ﬁle gateway and with ﬁle upload notiﬁcation turned on and settling time set to 60 seconds. Sample Request { "Authentication": "ActiveDirectory", "CacheAttributes": { "CacheStaleTimeoutInSeconds": 300 }, "CaseSensitivity": "ClientSpecified", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "FileShareName": "my-file-share", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "InvalidList": [ "user1", "user3", "@group2" ], "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/", "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}", "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ValidUserList": [ "user2", "@group1" ] } Examples API Version 2013-06-30 84 Storage Gateway Sample Response { API Reference "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Create an SMB ﬁle share with ﬁle upload notiﬁcation oﬀ In the following request, you create an SMB ﬁle share using an existing ﬁle gateway and with ﬁle upload notiﬁcation turned oﬀ. Sample Request { "Authentication": "ActiveDirectory", "CacheAttributes": { "CacheStaleTimeoutInSeconds": 300 }, "CaseSensitivity": "ClientSpecified", "ClientToken": "xy23421", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "FileShareName": "my-file-share", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "InvalidList": [ "user1", "user3", "@group2" ], "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/", "NotificationPolicy": "{}", "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ValidUserList": [ "user2", "@group1" ] } Examples API Version 2013-06-30 85 Storage Gateway Sample Response { API Reference "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 86 Storage Gateway CreateSnapshot Initiates a snapshot of a volume. API Reference Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable oﬀ-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule. In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of speciﬁed volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. Note To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. Important Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page. Request Syntax { "SnapshotDescription": "string", "Tags": [ { "Key": "string", "Value": "string" } ], CreateSnapshot API Version 2013-06-30 87 Storage Gateway "VolumeARN": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SnapshotDescription Textual description of the snapshot that appears in the Amazon EC2 console,
storagegateway-api-024	storagegateway-api.pdf	24	see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. Important Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page. Request Syntax { "SnapshotDescription": "string", "Tags": [ { "Key": "string", "Value": "string" } ], CreateSnapshot API Version 2013-06-30 87 Storage Gateway "VolumeARN": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SnapshotDescription Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description ﬁeld, and in the Storage Gateway snapshot Details pane, Description ﬁeld. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes Tags A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Request Parameters API Version 2013-06-30 88 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "SnapshotId": "string", "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SnapshotId The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume). Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}\|[0-9A-Fa-f]{17})\z VolumeARN The Amazon Resource Name (ARN) of the volume of which the snapshot was taken. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Response Syntax API Version 2013-06-30 89 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 ServiceUnavailableError An internal server error has occurred because the service is unavailable. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example sends a CreateSnapshot request to take snapshot of the speciﬁed an example volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.CreateSnapshot { Errors API Version 2013-06-30 90 Storage Gateway API Reference "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "SnapshotDescription": "snapshot description" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 128 { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "SnapshotId": "snap-78e22663" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 91 Storage Gateway API Reference CreateSnapshotFromVolumeRecoveryPoint Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the speciﬁed volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. Note To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. Request Syntax { "SnapshotDescription": "string", "Tags": [ { "Key": "string", "Value":
storagegateway-api-025	storagegateway-api.pdf	25	a description for the snapshot. When the gateway takes a snapshot of the speciﬁed volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. Note To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. Request Syntax { "SnapshotDescription": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. CreateSnapshotFromVolumeRecoveryPoint API Version 2013-06-30 92 Storage Gateway API Reference The request accepts the following data in JSON format. SnapshotDescription Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description ﬁeld, and in the Storage Gateway snapshot Details pane, Description ﬁeld. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes Tags A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No VolumeARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for speciﬁed VolumeARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Request Parameters API Version 2013-06-30 93 API Reference Storage Gateway Required: Yes Response Syntax { "SnapshotId": "string", "VolumeARN": "string", "VolumeRecoveryPointTime": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SnapshotId The ID of the snapshot. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}\|[0-9A-Fa-f]{17})\z VolumeARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for speciﬁed VolumeARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) VolumeRecoveryPointTime The time the volume was created from the recovery point. Type: String Response Syntax API Version 2013-06-30 94 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 ServiceUnavailableError An internal server error has occurred because the service is unavailable. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example sends a CreateSnapshotFromVolumeRecoveryPoint request to take snapshot of the speciﬁed an example volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.CreateSnapshotFromVolumeRecoveryPoint Errors API Version 2013-06-30 95 Storage Gateway API Reference { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "SnapshotDescription": "snapshot description" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 137 { "SnapshotId": "snap-78e22663", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "VolumeRecoveryPointTime": "2012-06-30T10:10:10.000Z" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 96 Storage Gateway API Reference CreateStorediSCSIVolume Creates a volume on a speciﬁed gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect
storagegateway-api-026	storagegateway-api.pdf	26	the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Request Syntax { "DiskId": "string", "GatewayARN": "string", "KMSEncrypted": boolean, "KMSKey": "string", "NetworkInterfaceId": "string", "PreserveExistingData": boolean, "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateStorediSCSIVolume API Version 2013-06-30 97 Storage Gateway DiskId API Reference The unique identiﬁer for the gateway local disk that is conﬁgured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Required: Yes GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes KMSEncrypted Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. Valid Values: true \| false Type: Boolean Required: No KMSKey The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Request Parameters API Version 2013-06-30 98 Storage Gateway Required: No NetworkInterfaceId API Reference The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. 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 Required: Yes PreserveExistingData Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume. Valid Values: true \| false Type: Boolean Required: Yes SnapshotId The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this ﬁeld if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this ﬁeld. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}\|[0-9A-Fa-f]{17})\z Required: No Tags A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair. Request Parameters API Version 2013-06-30 99 Storage Gateway Note API Reference Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No TargetName The name of the iSCSI target used by an initiator to connect to a volume and used as a suﬃx for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[-\.;a-z0-9]+$ Required: Yes Response Syntax { "TargetARN": "string", "VolumeARN": "string", "VolumeSizeInBytes": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2013-06-30 100 Storage Gateway API Reference The following data is returned in JSON format by the service. TargetARN The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. VolumeARN The Amazon Resource Name (ARN) of the conﬁgured volume. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) VolumeSizeInBytes The size of the volume in bytes. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred
storagegateway-api-027	storagegateway-api.pdf	27	returned in JSON format by the service. TargetARN The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. VolumeARN The Amazon Resource Name (ARN) of the conﬁgured volume. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) VolumeSizeInBytes The size of the volume in bytes. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. Errors API Version 2013-06-30 101 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example shows a request that speciﬁes that a local disk of a gateway be conﬁgured as a volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.CreateStorediSCSIVolume { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "PreserveExistingData": true, "TargetName": "myvolume", "NetworkInterfaceId": "10.1.1.1" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 215 { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "VolumeSizeInBytes": 1099511627776, "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume" Examples API Version 2013-06-30 102 Storage Gateway } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 103 Storage Gateway CreateTapePool API Reference Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool. Request Syntax { "PoolName": "string", "RetentionLockTimeInDays": number, "RetentionLockType": "string", "StorageClass": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PoolName The name of the new custom tape pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[ -\.0-\[\]-~][!-\.0-\[\]-~][ -\.0-\[\]-~]*$ Required: Yes RetentionLockTimeInDays Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days). CreateTapePool API Version 2013-06-30 104 Storage Gateway Type: Integer API Reference Valid Range: Minimum value of 0. Maximum value of 36500. Required: No RetentionLockType Tape retention lock can be conﬁgured in two modes. When conﬁgured in governance mode, AWS accounts with speciﬁc IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When conﬁgured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account. Type: String Valid Values: COMPLIANCE \| GOVERNANCE \| NONE Required: No StorageClass The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. Type: String Valid Values: DEEP_ARCHIVE \| GLACIER Required: Yes Tags A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Request Parameters API Version 2013-06-30 105 API Reference Storage Gateway Required: No Response Syntax { "PoolARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. PoolARN The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the
storagegateway-api-028	storagegateway-api.pdf	28	returned in JSON format by the service. PoolARN The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 106 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 107 Storage Gateway CreateTapes API Reference Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Note Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway. Request Syntax { "ClientToken": "string", "GatewayARN": "string", "KMSEncrypted": boolean, "KMSKey": "string", "NumTapesToCreate": number, "PoolId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TapeBarcodePrefix": "string", "TapeSizeInBytes": number, "Worm": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken A unique identiﬁer that you use to retry a request. If you retry a request, use the same ClientToken you speciﬁed in the initial request. CreateTapes API Version 2013-06-30 108 Storage Gateway Note API Reference Using the same ClientToken prevents creating the tape multiple times. Type: String Length Constraints: Minimum length of 5. Maximum length of 100. Required: Yes GatewayARN The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes KMSEncrypted Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. Valid Values: true \| false Type: Boolean Required: No KMSKey The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Request Parameters API Version 2013-06-30 109 Storage Gateway API Reference Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No NumTapesToCreate The number of virtual tapes that you want to create. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: Yes PoolId The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No Tags A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No Request Parameters API Version 2013-06-30 110 Storage Gateway TapeBarcodePreﬁx API Reference A preﬁx that you append to the barcode of the virtual tape you are creating. This preﬁx makes the barcode unique. Note The preﬁx must be 1-4 characters in length and must be one of the uppercase letters from A to Z. Type: String Length Constraints: Minimum length of 1. Maximum length of 4. Pattern: ^[A-Z]$ Required: Yes TapeSizeInBytes The size, in bytes, of the virtual tapes that you want to create. Note The size must be aligned by gigabyte (102410241024
storagegateway-api-029	storagegateway-api.pdf	29	256. Type: Array of Tag objects Required: No Request Parameters API Version 2013-06-30 110 Storage Gateway TapeBarcodePreﬁx API Reference A preﬁx that you append to the barcode of the virtual tape you are creating. This preﬁx makes the barcode unique. Note The preﬁx must be 1-4 characters in length and must be one of the uppercase letters from A to Z. Type: String Length Constraints: Minimum length of 1. Maximum length of 4. Pattern: ^[A-Z]$ Required: Yes TapeSizeInBytes The size, in bytes, of the virtual tapes that you want to create. Note The size must be aligned by gigabyte (102410241024 bytes). Type: Long Required: Yes Worm Set to TRUE if the tape you are creating is to be conﬁgured as a write-once-read-many (WORM) tape. Type: Boolean Required: No Request Parameters API Version 2013-06-30 111 Storage Gateway Response Syntax { "TapeARNs": [ "string" ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARNs A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 112 Storage Gateway Examples Create tapes in a tape gateway API Reference In the following request, you add three virtual tape cartridges, 100 GB each in size, to the tape gateway with the ID sgw-12A3456B. The tapes appear in the gateway's virtual tape library. In the request, you set the tape's barcode preﬁx to "TEST". Sample Request { "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "TapeSizeInBytes": "107374182400", "ClientToken": "77777", "NumTapesToCreate": "3", "PooId": "Deep_Archive", "TapeBarcodePrefix": "TEST" } Sample Response { "TapeARNs": [ "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST38A29D", "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST3AA29F", "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST3BA29E" ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Examples API Version 2013-06-30 113 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 114 Storage Gateway API Reference CreateTapeWithBarcode Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Note Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway. Request Syntax { "GatewayARN": "string", "KMSEncrypted": boolean, "KMSKey": "string", "PoolId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TapeBarcode": "string", "TapeSizeInBytes": number, "Worm": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateTapeWithBarcode API Version 2013-06-30 115 Storage Gateway GatewayARN API Reference The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes KMSEncrypted Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. Valid Values: true \| false Type: Boolean Required: No KMSKey The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No PoolId The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
storagegateway-api-030	storagegateway-api.pdf	30	encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: (^arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):kms:([a-zA-Z0-9-]+): ([0-9]+):(key\|alias)/(\S+)$)\|(^alias/(\S+)$) Required: No PoolId The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool. Request Parameters API Version 2013-06-30 116 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 100. Required: No Tags A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. Type: Array of Tag objects Required: No TapeBarcode The barcode that you want to assign to the tape. Note Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted. Type: String Length Constraints: Minimum length of 5. Maximum length of 16. Pattern: ^[A-Z0-9]$ Required: Yes TapeSizeInBytes The size, in bytes, of the virtual tape that you want to create. Request Parameters API Version 2013-06-30 117 Storage Gateway Note The size must be aligned by gigabyte (102410241024 bytes). API Reference Type: Long Required: Yes Worm Set to TRUE if the tape you are creating is to be conﬁgured as a write-once-read-many (WORM) tape. Type: Boolean Required: No Response Syntax { "TapeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN A unique Amazon Resource Name (ARN) that represents the virtual tape that was created. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Response Syntax API Version 2013-06-30 118 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Create a tape with your own barcode in a tape gateway In the following request, you add a 100 GB tape cartridge to the tape gateway with the ID sgw-12A3456B. The tape appears in the gateway's virtual tape library. In the request, you set the barcode to "TEST12345". Sample Request { "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "TapeSizeInBytes": "107374182400", "PooId": "Deep_Archive", "TapeBarcode": "TEST12345" } Sample Response { "TapeARN": [ Errors API Version 2013-06-30 119 Storage Gateway API Reference "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST12345" ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 120 Storage Gateway API Reference DeleteAutomaticTapeCreationPolicy Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DeleteAutomaticTapeCreationPolicy API Version 2013-06-30 121 Storage Gateway API Reference The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For
storagegateway-api-031	storagegateway-api.pdf	31	for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DeleteAutomaticTapeCreationPolicy API Version 2013-06-30 121 Storage Gateway API Reference The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that deletes the automatic tape creation policy of the gateway. Sample Request { "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan" } Errors API Version 2013-06-30 122 Storage Gateway Sample Response { API Reference "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 123 Storage Gateway API Reference DeleteBandwidthRateLimit Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types. Request Syntax { "BandwidthType": "string", "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BandwidthType One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: UPLOAD \| DOWNLOAD \| ALL Type: String Length Constraints: Minimum length of 3. Maximum length of 25. Required: Yes GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. DeleteBandwidthRateLimit API Version 2013-06-30 124 API Reference Storage Gateway Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 125 Storage Gateway Examples Example request API Reference The following example shows a request that deletes both of the bandwidth rate limits of a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteBandwidthRateLimit { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "BandwidthType": "All" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples API Version 2013-06-30 126 Storage Gateway • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 127 Storage Gateway DeleteCacheReport API Reference Deletes the speciﬁed cache report and any associated tags from the AWS Storage Gateway database. You can only delete completed reports. If the
storagegateway-api-032	storagegateway-api.pdf	32	the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples API Version 2013-06-30 126 Storage Gateway • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 127 Storage Gateway DeleteCacheReport API Reference Deletes the speciﬁed cache report and any associated tags from the AWS Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. Note DeleteCacheReport does not delete the report object from your Amazon S3 bucket. Request Syntax { "CacheReportARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CacheReportARN The Amazon Resource Name (ARN) of the cache report you want to delete. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CacheReportARN": "string" DeleteCacheReport API Version 2013-06-30 128 API Reference Storage Gateway } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CacheReportARN The Amazon Resource Name (ARN) of the cache report you want to delete. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Cancel a cache report The following example deletes metadate for the cache report with the speciﬁed ARN, without removing the report object from Amazon S3. Response Elements API Version 2013-06-30 129 Storage Gateway Sample Request POST / HTTP/1.1 API Reference Host: storagegateway.us-east-1.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteCacheReport { "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234/cache-report/report-ABCD1234" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234/cache-report/report-ABCD1234" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2013-06-30 130 Storage Gateway • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 131 Storage Gateway API Reference DeleteChapCredentials Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a speciﬁed iSCSI target and initiator pair. This operation is supported in volume and tape gateway types. Request Syntax { "InitiatorName": "string", "TargetARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InitiatorName The iSCSI initiator that connects to the target. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [0-9a-z:.-]+ Required: Yes TargetARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for speciﬁed VolumeARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Required: Yes DeleteChapCredentials API Version 2013-06-30 132 API Reference Storage Gateway Response Syntax { "InitiatorName": "string", "TargetARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InitiatorName The iSCSI initiator that connects to the target. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [0-9a-z:.-]+ TargetARN The Amazon Resource Name (ARN) of the target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 133 Storage Gateway API Reference InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that deletes the CHAP credentials for
storagegateway-api-033	storagegateway-api.pdf	33	Length Constraints: Minimum length of 50. Maximum length of 800. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 133 Storage Gateway API Reference InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that deletes the CHAP credentials for an iSCSI target myvolume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteChapCredentials { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 161 { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" Examples API Version 2013-06-30 134 Storage Gateway } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 135 Storage Gateway DeleteFileShare API Reference Deletes a ﬁle share from an S3 File Gateway. This operation is only supported for S3 File Gateways. Request Syntax { "FileShareARN": "string", "ForceDelete": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARN The Amazon Resource Name (ARN) of the ﬁle share to be deleted. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes ForceDelete If this value is set to true, the operation deletes a ﬁle share immediately and aborts all data uploads to AWS. Otherwise, the ﬁle share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the ﬁle share enters the FORCE_DELETING status. Valid Values: true \| false Type: Boolean Required: No Response Syntax { DeleteFileShare API Version 2013-06-30 136 API Reference Storage Gateway "FileShareARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileShareARN The Amazon Resource Name (ARN) of the deleted ﬁle share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Delete a ﬁle share In the following request, you delete a ﬁle share from a S3 File Gateway. Response Elements API Version 2013-06-30 137 Storage Gateway Sample Request { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share- API Reference XXXXXXXX" } Sample Response { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share- XXXXXXXX" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 138 Storage Gateway DeleteGateway API Reference Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. Important You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page. Request Syntax {
storagegateway-api-034	storagegateway-api.pdf	34	the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. Important You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. DeleteGateway API Version 2013-06-30 139 API Reference Storage Gateway Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 140 Storage Gateway Examples Delete a gateway API Reference The following example shows a request that deactivates a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteGateway { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Examples API Version 2013-06-30 141 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 142 Storage Gateway API Reference DeleteSnapshotSchedule Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. Note To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. Request Syntax { "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARN The volume which snapshot schedule to delete. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes DeleteSnapshotSchedule API Version 2013-06-30 143 Storage Gateway Response Syntax { "VolumeARN": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. VolumeARN The volume which snapshot schedule was deleted. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 144 Storage Gateway Examples Example request API Reference The following example shows a request that deletes a snapshot schedule. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.DeleteSnapshotSchedule { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1
storagegateway-api-035	storagegateway-api.pdf	35	An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 144 Storage Gateway Examples Example request API Reference The following example shows a request that deletes a snapshot schedule. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.DeleteSnapshotSchedule { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 137 { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Examples API Version 2013-06-30 145 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 146 Storage Gateway DeleteTape API Reference Deletes the speciﬁed virtual tape. This operation is only supported in the tape gateway type. Request Syntax { "BypassGovernanceRetention": boolean, "GatewayARN": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BypassGovernanceRetention Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted. Type: Boolean Required: No GatewayARN The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes TapeARN The Amazon Resource Name (ARN) of the virtual tape to delete. DeleteTape API Version 2013-06-30 147 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: Yes Response Syntax { "TapeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The Amazon Resource Name (ARN) of the deleted virtual tape. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Syntax API Version 2013-06-30 148 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Delete a tape from a gateway The following example deletes a tape from a tape gateway with ID sgw-12A3456B. The request identiﬁes the tape by its ARN. The operation deletes the tapes from the speciﬁed gateway's virtual tape library (VTL). In the response, tape gateway returns the ARN of deleted tape. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20131025T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteTape { "GatewayARN": "arn:aws:storagegateway:us-east-2:123456789012:gateway/sgw-12A3456B", "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0" } Sample Response { "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2013-06-30 149 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 150 Storage Gateway DeleteTapeArchive API Reference Deletes the speciﬁed virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. Request Syntax { "BypassGovernanceRetention": boolean, "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BypassGovernanceRetention Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance
storagegateway-api-036	storagegateway-api.pdf	36	Storage Gateway DeleteTapeArchive API Reference Deletes the speciﬁed virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. Request Syntax { "BypassGovernanceRetention": boolean, "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BypassGovernanceRetention Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted. Type: Boolean Required: No TapeARN The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: Yes DeleteTapeArchive API Version 2013-06-30 151 Storage Gateway Response Syntax { "TapeARN": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TapeARN The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 152 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 153 Storage Gateway DeleteTapePool API Reference Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool. Request Syntax { "PoolARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PoolARN The Amazon Resource Name (ARN) of the custom tape pool to delete. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "PoolARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeleteTapePool API Version 2013-06-30 154 Storage Gateway PoolARN API Reference The Amazon Resource Name (ARN) of the custom tape pool being deleted. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2013-06-30 155 Storage Gateway • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 156 Storage Gateway DeleteVolume API Reference Deletes the speciﬁed storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was conﬁgured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are
storagegateway-api-037	storagegateway-api.pdf	37	volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was conﬁgured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. Request Syntax { "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) DeleteVolume API Version 2013-06-30 157 API Reference Storage Gateway Required: Yes Response Syntax { "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. VolumeARN The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. Response Syntax API Version 2013-06-30 158 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example shows a request that deletes a volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DeleteVolume { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 99 { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Examples API Version 2013-06-30 159 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 160 Storage Gateway API Reference DescribeAvailabilityMonitorTest Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "GatewayARN": "string", "StartTime": number, "Status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DescribeAvailabilityMonitorTest API Version 2013-06-30 161 Storage Gateway API Reference The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. StartTime The time the high availability monitoring test was started. If a test hasn't been performed, the value of this ﬁeld is null. Type: Timestamp Status The status of the high availability monitoring test. If a test hasn't been performed, the value of this ﬁeld is null. Type: String Valid Values: COMPLETE \| FAILED \| PENDING Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway
storagegateway-api-038	storagegateway-api.pdf	38	time the high availability monitoring test was started. If a test hasn't been performed, the value of this ﬁeld is null. Type: Timestamp Status The status of the high availability monitoring test. If a test hasn't been performed, the value of this ﬁeld is null. Type: String Valid Values: COMPLETE \| FAILED \| PENDING Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Errors API Version 2013-06-30 162 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 163 Storage Gateway API Reference DescribeBandwidthRateLimit Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in eﬀect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 ﬁle gateways, use DescribeBandwidthRateLimitSchedule. This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "AverageDownloadRateLimitInBitsPerSec": number, "AverageUploadRateLimitInBitsPerSec": number, "GatewayARN": "string" DescribeBandwidthRateLimit API Version 2013-06-30 164 Storage Gateway } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AverageDownloadRateLimitInBitsPerSec The average download bandwidth rate limit in bits per second. This ﬁeld does not appear in the response if the download rate limit is not set. Type: Long Valid Range: Minimum value of 102400. AverageUploadRateLimitInBitsPerSec The average upload bandwidth rate limit in bits per second. This ﬁeld does not appear in the response if the upload rate limit is not set. Type: Long Valid Range: Minimum value of 51200. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 165 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that returns the bandwidth throttle properties of a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeBandwidthRateLimit { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 169 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "AverageUploadRateLimitInBitsPerSec": "102400", "AverageDownloadRateLimitInBitsPerSec": "51200" } Examples API Version 2013-06-30 166 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 167 Storage Gateway API Reference DescribeBandwidthRateLimitSchedule Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in
storagegateway-api-039	storagegateway-api.pdf	39	AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 167 Storage Gateway API Reference DescribeBandwidthRateLimitSchedule Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in eﬀect. This operation is supported only for volume, tape and S3 ﬁle gateways. FSx ﬁle gateways do not support bandwidth rate limits. This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval deﬁnes a period of time on one or more days of the week, during which bandwidth rate limits are speciﬁed for uploading, downloading, or both. A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. DescribeBandwidthRateLimitSchedule API Version 2013-06-30 168 API Reference Storage Gateway Required: Yes Response Syntax { "BandwidthRateLimitIntervals": [ { "AverageDownloadRateLimitInBitsPerSec": number, "AverageUploadRateLimitInBitsPerSec": number, "DaysOfWeek": [ number ], "EndHourOfDay": number, "EndMinuteOfHour": number, "StartHourOfDay": number, "StartMinuteOfHour": number } ], "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BandwidthRateLimitIntervals An array that contains the bandwidth rate limit intervals for a tape or volume gateway. Type: Array of BandwidthRateLimitInterval objects Array Members: Minimum number of 0 items. Maximum number of 20 items. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Response Syntax API Version 2013-06-30 169 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 170 Storage Gateway DescribeCache API Reference Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and ﬁle gateway types. The response includes disk IDs that are conﬁgured as cache, and it includes the amount of cache allocated and used. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CacheAllocatedInBytes": number, "CacheDirtyPercentage": number, "CacheHitPercentage": number, "CacheMissPercentage": number, "CacheUsedPercentage": number, DescribeCache API Version 2013-06-30 171 Storage Gateway API Reference "DiskIds": [ "string" ], "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CacheAllocatedInBytes The amount of cache in bytes allocated to a gateway. Type: Long CacheDirtyPercentage The ﬁle share's contribution to the overall percentage of the gateway's cache that
storagegateway-api-040	storagegateway-api.pdf	40	account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CacheAllocatedInBytes": number, "CacheDirtyPercentage": number, "CacheHitPercentage": number, "CacheMissPercentage": number, "CacheUsedPercentage": number, DescribeCache API Version 2013-06-30 171 Storage Gateway API Reference "DiskIds": [ "string" ], "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CacheAllocatedInBytes The amount of cache in bytes allocated to a gateway. Type: Long CacheDirtyPercentage The ﬁle share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period. Type: Double CacheHitPercentage Percent of application read operations from the ﬁle shares that are served from cache. The sample is taken at the end of the reporting period. Type: Double CacheMissPercentage Percent of application read operations from the ﬁle shares that are not served from cache. The sample is taken at the end of the reporting period. Type: Double CacheUsedPercentage Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period. Type: Double Response Elements API Version 2013-06-30 172 Storage Gateway DiskIds API Reference An array of strings that identify disks that are to be conﬁgured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Return information about a gateway's cache The following example shows a request to obtain a description of a gateway's working storage. Errors API Version 2013-06-30 173 Storage Gateway Sample Request POST / HTTP/1.1 API Reference Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.DescribeCache { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 271 { "CacheAllocationInBytes": "2199023255552", "CacheDirtyPercentage": "0.07", "CacheHitPercentage": "99.68", "CacheMissPercentage": "0.32", "CacheUsedPercentage": "0.07", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0" ], "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2013-06-30 174 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 175 Storage Gateway API Reference DescribeCachediSCSIVolumes Returns a description of the gateway volumes speciﬁed in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). Request Syntax { "VolumeARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARNs An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the speciﬁed cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "CachediSCSIVolumes": [ { "CreatedDate": number, DescribeCachediSCSIVolumes API Version 2013-06-30 176 Storage Gateway API Reference "KMSKey": "string", "SourceSnapshotId": "string", "TargetName": "string", "VolumeARN": "string", "VolumeAttachmentStatus": "string", "VolumeId": "string", "VolumeiSCSIAttributes": { "ChapEnabled": boolean, "LunNumber": number, "NetworkInterfaceId": "string", "NetworkInterfacePort": number, "TargetARN": "string" }, "VolumeProgress": number, "VolumeSizeInBytes": number, "VolumeStatus": "string", "VolumeType": "string", "VolumeUsedInBytes": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CachediSCSIVolumes An array of objects where each object contains metadata about one cached volume. Type: Array of CachediSCSIVolume objects Errors For
storagegateway-api-041	storagegateway-api.pdf	41	{ "CachediSCSIVolumes": [ { "CreatedDate": number, DescribeCachediSCSIVolumes API Version 2013-06-30 176 Storage Gateway API Reference "KMSKey": "string", "SourceSnapshotId": "string", "TargetName": "string", "VolumeARN": "string", "VolumeAttachmentStatus": "string", "VolumeId": "string", "VolumeiSCSIAttributes": { "ChapEnabled": boolean, "LunNumber": number, "NetworkInterfaceId": "string", "NetworkInterfacePort": number, "TargetARN": "string" }, "VolumeProgress": number, "VolumeSizeInBytes": number, "VolumeStatus": "string", "VolumeType": "string", "VolumeUsedInBytes": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CachediSCSIVolumes An array of objects where each object contains metadata about one cached volume. Type: Array of CachediSCSIVolume objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 177 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that returns a description of a volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.DescribeCachediSCSIVolumes { "VolumeARNs": [ "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/ vol-1122AABB" ] } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 664 { Examples API Version 2013-06-30 178 Storage Gateway API Reference "CachediSCSIVolumes": [ { "VolumeiSCSIAttributes": { "ChapEnabled": "true", "LunNumber": "0", "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": "3260", "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, "KMSKey": "arn:aws:kms:us-east-1:11111111:key/ b72aaa2a-2222-99tt-12345690qwe", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/ sgw-12A3456B/volume/vol-1122AABB", "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "VolumeId": "vol-1122AABB", "VolumeSizeInBytes": "1099511627776", "VolumeStatus": "AVAILABLE", "VolumeType": "CACHED iSCSI", "VolumeUsedInBytes": "1090000000000" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 179 Storage Gateway API Reference See Also API Version 2013-06-30 180 Storage Gateway API Reference DescribeCacheReport Returns information about the speciﬁed cache report, including completion status and generation progress. Request Syntax { "CacheReportARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CacheReportARN The Amazon Resource Name (ARN) of the cache report you want to describe. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CacheReportInfo": { "CacheReportARN": "string", "CacheReportStatus": "string", "EndTime": number, "ExclusionFilters": [ { "Name": "string", "Values": [ "string" ] } ], DescribeCacheReport API Version 2013-06-30 181 Storage Gateway API Reference "FileShareARN": "string", "InclusionFilters": [ { "Name": "string", "Values": [ "string" ] } ], "LocationARN": "string", "ReportCompletionPercent": number, "ReportName": "string", "Role": "string", "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CacheReportInfo Contains all informational ﬁelds associated with a cache report. Includes name, ARN, tags, status, progress, ﬁlters, start time, and end time. Type: CacheReportInfo object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 182 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Get information about a cache report The following example gets information about the cache report with the speciﬁed ARN. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-1.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeCacheReport { "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234/cache-report/report-ABCD1234" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 80 { "CacheReportInfo": { "CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share- ABCD1234/cache-report/report-ABCD1234", "CacheReportStatus": "COMPLETED", Examples API Version 2013-06-30 183 Storage Gateway API Reference "ReportCompletionPercent": 100, "EndTime": "2025-02-11T21:32:09.535000+00:00", "Role": "arn:aws:iam::123456789012:role/bucket-access-role", "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234", "LocationARN": "arn:aws:s3:::bucket-bane", "StartTime": "2025-02-11T21:31:42.081000+00:00", "InclusionFilters": [ { "Name": "UploadFailureReason", "Values": [ "InaccessibleStorageClass", "ObjectMissing" ] } ], "ReportName": "cache_report-ABCD1234_1739309502081.csv", "Tags": [] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS
storagegateway-api-042	storagegateway-api.pdf	42	{ "CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share- ABCD1234/cache-report/report-ABCD1234", "CacheReportStatus": "COMPLETED", Examples API Version 2013-06-30 183 Storage Gateway API Reference "ReportCompletionPercent": 100, "EndTime": "2025-02-11T21:32:09.535000+00:00", "Role": "arn:aws:iam::123456789012:role/bucket-access-role", "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share- ABCD1234", "LocationARN": "arn:aws:s3:::bucket-bane", "StartTime": "2025-02-11T21:31:42.081000+00:00", "InclusionFilters": [ { "Name": "UploadFailureReason", "Values": [ "InaccessibleStorageClass", "ObjectMissing" ] } ], "ReportName": "cache_report-ABCD1234_1739309502081.csv", "Tags": [] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 184 Storage Gateway API Reference DescribeChapCredentials Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a speciﬁed iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types. Request Syntax { "TargetARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. TargetARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for speciﬁed VolumeARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Required: Yes Response Syntax { "ChapCredentials": [ { "InitiatorName": "string", "SecretToAuthenticateInitiator": "string", "SecretToAuthenticateTarget": "string", "TargetARN": "string" } ] DescribeChapCredentials API Version 2013-06-30 185 Storage Gateway } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ChapCredentials An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following ﬁelds: • InitiatorName: The iSCSI initiator that connects to the target. • SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. • SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). • TargetARN: The Amazon Resource Name (ARN) of the storage volume. Type: Array of ChapInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Response Elements API Version 2013-06-30 186 Storage Gateway Examples Example request API Reference The following example shows a request that returns the CHAP credentials of an iSCSI target. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeChapCredentials { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ target/iqn.1997-05.com.amazon:myvolume" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 235 { "ChapCredentials": { "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", "SecretToAuthenticateInitiator": "111111111111", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", "SecretToAuthenticateTarget": "222222222222" } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2013-06-30 187 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 188 Storage Gateway API Reference DescribeFileSystemAssociations Gets the ﬁle system association information. This operation is only supported for FSx File Gateways. Request Syntax { "FileSystemAssociationARNList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileSystemAssociationARNList An array containing the Amazon Resource Name (ARN) of each ﬁle system association to be described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "FileSystemAssociationInfoList": [ { "AuditDestinationARN": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "EndpointNetworkConfiguration": { DescribeFileSystemAssociations API Version 2013-06-30 189 Storage Gateway API Reference "IpAddresses": [ "string" ] }, "FileSystemAssociationARN": "string", "FileSystemAssociationStatus": "string", "FileSystemAssociationStatusDetails": [ { "ErrorCode": "string" } ], "GatewayARN": "string", "LocationARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ] } Response Elements If the action is successful, the service sends back an
storagegateway-api-043	storagegateway-api.pdf	43	association to be described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "FileSystemAssociationInfoList": [ { "AuditDestinationARN": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "EndpointNetworkConfiguration": { DescribeFileSystemAssociations API Version 2013-06-30 189 Storage Gateway API Reference "IpAddresses": [ "string" ] }, "FileSystemAssociationARN": "string", "FileSystemAssociationStatus": "string", "FileSystemAssociationStatusDetails": [ { "ErrorCode": "string" } ], "GatewayARN": "string", "LocationARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileSystemAssociationInfoList An array containing the FileSystemAssociationInfo data type of each ﬁle system association to be described. Type: Array of FileSystemAssociationInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 190 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeFileSystemAssociations. __Sample Request__ { "FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs- association/fsa-1122AABBCCDDEEFFG"] } Example This example illustrates one usage of DescribeFileSystemAssociations. __Sample Response__ { "FileSystemAssociationInfoList": [ "FileSystemAssociationARN": "arn:aws:storagegateway:us-east-1:111122223333:fs- association/fsa-1122AABBCCDDEEFFG", "FileSystemAssociationStatus": " AVAILABLE", "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/ sgw-7A8D6313", "LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/ fs-0bb4bf5cedebd814f", "Tags": [] } ] } Examples API Version 2013-06-30 191 Storage Gateway See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 192 Storage Gateway API Reference DescribeGatewayInformation Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "CloudWatchLogGroupARN": "string", "DeprecationDate": "string", "Ec2InstanceId": "string", "Ec2InstanceRegion": "string", "EndpointType": "string", "GatewayARN": "string", "GatewayCapacity": "string", DescribeGatewayInformation API Version 2013-06-30 193 Storage Gateway API Reference "GatewayId": "string", "GatewayName": "string", "GatewayNetworkInterfaces": [ { "Ipv4Address": "string", "Ipv6Address": "string", "MacAddress": "string" } ], "GatewayState": "string", "GatewayTimezone": "string", "GatewayType": "string", "HostEnvironment": "string", "HostEnvironmentId": "string", "LastSoftwareUpdate": "string", "NextUpdateAvailabilityDate": "string", "SoftwareUpdatesEndDate": "string", "SoftwareVersion": "string", "SupportedGatewayCapacities": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VPCEndpoint": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CloudWatchLogGroupARN The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This ﬁeld only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM Type: String Length Constraints: Maximum length of 562. Response Elements API Version 2013-06-30 194 Storage Gateway DeprecationDate API Reference Date after which this gateway will not receive software updates for new features and bug ﬁxes. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. Ec2InstanceId The ID of the Amazon EC2 instance that was used to launch the gateway. Type: String Ec2InstanceRegion The AWS Region where the Amazon EC2 instance is located. Type: String EndpointType The type of endpoint for your gateway. Valid Values: STANDARD \| FIPS Type: String Length Constraints: Minimum length of 4. Maximum length of 8. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. GatewayCapacity Speciﬁes the size of the gateway's metadata cache. Type: String Valid Values: Small \| Medium \| Large Response Elements API Version 2013-06-30 195 Storage Gateway GatewayId API Reference The unique identiﬁer assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
storagegateway-api-044	storagegateway-api.pdf	44	of 4. Maximum length of 8. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. GatewayCapacity Speciﬁes the size of the gateway's metadata cache. Type: String Valid Values: Small \| Medium \| Large Response Elements API Version 2013-06-30 195 Storage Gateway GatewayId API Reference The unique identiﬁer assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations. Type: String Length Constraints: Minimum length of 12. Maximum length of 30. GatewayName The name you conﬁgured for your gateway. Type: String GatewayNetworkInterfaces A NetworkInterface array that contains descriptions of the gateway network interfaces. Type: Array of NetworkInterface objects GatewayState A value that indicates the operating state of the gateway. Type: String Length Constraints: Minimum length of 2. Maximum length of 25. GatewayTimezone A value that indicates the time zone conﬁgured for the gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 10. GatewayType The type of the gateway. Important Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Response Elements API Version 2013-06-30 196 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 2. Maximum length of 20. HostEnvironment The type of hardware or software platform on which the gateway is running. Note Tape Gateway is no longer available on Snow Family devices. Type: String Valid Values: VMWARE \| HYPER-V \| EC2 \| KVM \| OTHER \| SNOWBALL HostEnvironmentId A unique identiﬁer for the speciﬁc instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. LastSoftwareUpdate The date on which the last software update was applied to the gateway. If the gateway has never been updated, this ﬁeld does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM Type: String Length Constraints: Minimum length of 1. Maximum length of 25. NextUpdateAvailabilityDate The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this ﬁeld is not returned in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. Response Elements API Version 2013-06-30 197 Storage Gateway SoftwareUpdatesEndDate API Reference Date after which this gateway will not receive software updates for new features. Type: String Length Constraints: Minimum length of 1. Maximum length of 25. SoftwareVersion The version number of the software running on the gateway appliance. Type: String SupportedGatewayCapacities A list of the metadata cache sizes that the gateway can support based on its current hardware speciﬁcations. Type: Array of strings Valid Values: Small \| Medium \| Large Tags A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. Type: Array of Tag objects VPCEndpoint The conﬁguration settings for the virtual private cloud (VPC) endpoint for your gateway. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Errors API Version 2013-06-30 198 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Return metadata about a gateway The following example shows a request for describing a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeGatewayInformation { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 227 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "GatewayId": "sgw-AABB1122", "GatewayNetworkInterfaces": [ { "Ipv4Address": "10.35.69.216" Examples API Version 2013-06-30 199 Storage Gateway } ], "GatewayState": "STATE_RUNNING", "GatewayTimezone": "GMT-8:00", "LastSoftwareUpdate": "2015-01-02T16:00:00", "NextUpdateAvailabilityDate": "2016-01-02T16:00:00" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java
storagegateway-api-045	storagegateway-api.pdf	45	application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeGatewayInformation { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 227 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "GatewayId": "sgw-AABB1122", "GatewayNetworkInterfaces": [ { "Ipv4Address": "10.35.69.216" Examples API Version 2013-06-30 199 Storage Gateway } ], "GatewayState": "STATE_RUNNING", "GatewayTimezone": "GMT-8:00", "LastSoftwareUpdate": "2015-01-02T16:00:00", "NextUpdateAvailabilityDate": "2016-01-02T16:00:00" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 200 Storage Gateway API Reference DescribeMaintenanceStartTime Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, speciﬁc day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "DayOfMonth": number, "DayOfWeek": number, "GatewayARN": "string", "HourOfDay": number, "MinuteOfHour": number, "SoftwareUpdatePreferences": { "AutomaticUpdatePolicy": "string" }, DescribeMaintenanceStartTime API Version 2013-06-30 201 Storage Gateway "Timezone": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DayOfMonth The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the ﬁrst day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31. Type: Integer Valid Range: Minimum value of 1. Maximum value of 28. DayOfWeek An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway. Type: Integer Valid Range: Minimum value of 0. Maximum value of 6. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. HourOfDay The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway. Type: Integer Response Elements API Version 2013-06-30 202 Storage Gateway API Reference Valid Range: Minimum value of 0. Maximum value of 23. MinuteOfHour The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway. Type: Integer Valid Range: Minimum value of 0. Maximum value of 59. SoftwareUpdatePreferences A set of variables indicating the software update preferences for the gateway. Includes AutomaticUpdatePolicy parameter with the following inputs: ALL_VERSIONS - Enables regular gateway maintenance updates. EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notiﬁed before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window. Type: SoftwareUpdatePreferences object Timezone A value that indicates the time zone that is set for the gateway. The start time and day of week speciﬁed should be in the time zone of the gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 10. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Errors API Version 2013-06-30 203 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Return information about a gateway's maintenance window The following example shows a request that describes a gateway's maintenance window. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeMaintenanceStartTime { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 136 { "GatewayARN":
storagegateway-api-046	storagegateway-api.pdf	46	ﬁelds. Errors API Version 2013-06-30 203 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Return information about a gateway's maintenance window The following example shows a request that describes a gateway's maintenance window. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeMaintenanceStartTime { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 136 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "DayOfMonth": "28", "DayOfWeek": "2", "HourOfDay": "15", "MinuteOfHour": "35", Examples API Version 2013-06-30 204 Storage Gateway "Timezone": "GMT+7:00" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 205 Storage Gateway API Reference DescribeNFSFileShares Gets a description for one or more Network File System (NFS) ﬁle shares from an S3 File Gateway. This operation is only supported for S3 File Gateways. Request Syntax { "FileShareARNList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARNList An array containing the Amazon Resource Name (ARN) of each ﬁle share to be described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "NFSFileShareInfoList": [ { "AuditDestinationARN": "string", "BucketRegion": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "ClientList": [ "string" ], "DefaultStorageClass": "string", DescribeNFSFileShares API Version 2013-06-30 206 Storage Gateway API Reference "EncryptionType": "string", "FileShareARN": "string", "FileShareId": "string", "FileShareName": "string", "FileShareStatus": "string", "GatewayARN": "string", "GuessMIMETypeEnabled": boolean, "KMSEncrypted": boolean, "KMSKey": "string", "LocationARN": "string", "NFSFileShareDefaults": { "DirectoryMode": "string", "FileMode": "string", "GroupId": number, "OwnerId": number }, "NotificationPolicy": "string", "ObjectACL": "string", "Path": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Role": "string", "Squash": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VPCEndpointDNSName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NFSFileShareInfoList An array containing a description for each requested ﬁle share. Response Elements API Version 2013-06-30 207 Storage Gateway API Reference Type: Array of NFSFileShareInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Describe an NFS ﬁle share In the following request, you get the description for a single ﬁle share identiﬁed by its Amazon Resource Name (ARN). Sample Request { "FileShareARNList": [ "arn:aws:storagegateway:us-east-2:204469490176:share/share-XXXXXX" ] } Sample Response { "NFSFileShareInfoList": [ { Errors API Version 2013-06-30 208 Storage Gateway API Reference "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share- XXXXXXXX", "FileShareId": "share-XXXXXXXX", "FileShareStatus": "AVAILABLE", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw- YYYYYYYY", "GuessMIMETypeEnabled": "true", "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/ b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket", "NFSFileShareDefaults": { "DirectoryMode": "0777", "FileMode": "0777", "GroupId": "500", "OwnerId": "500" }, "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "Path": "/my-path-alpha", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2013-06-30 209 Storage Gateway • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 210 Storage Gateway API Reference DescribeSMBFileShares Gets a description for one or more Server Message Block (SMB) ﬁle shares from a S3 File Gateway. This operation is only supported for S3 File Gateways. Request Syntax { "FileShareARNList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARNList An array containing the Amazon Resource Name (ARN) of each ﬁle share to be described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum
storagegateway-api-047	storagegateway-api.pdf	47	Storage Gateway API Reference DescribeSMBFileShares Gets a description for one or more Server Message Block (SMB) ﬁle shares from a S3 File Gateway. This operation is only supported for S3 File Gateways. Request Syntax { "FileShareARNList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARNList An array containing the Amazon Resource Name (ARN) of each ﬁle share to be described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "SMBFileShareInfoList": [ { "AccessBasedEnumeration": boolean, "AdminUserList": [ "string" ], "AuditDestinationARN": "string", "Authentication": "string", "BucketRegion": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number DescribeSMBFileShares API Version 2013-06-30 211 Storage Gateway API Reference }, "CaseSensitivity": "string", "DefaultStorageClass": "string", "EncryptionType": "string", "FileShareARN": "string", "FileShareId": "string", "FileShareName": "string", "FileShareStatus": "string", "GatewayARN": "string", "GuessMIMETypeEnabled": boolean, "InvalidUserList": [ "string" ], "KMSEncrypted": boolean, "KMSKey": "string", "LocationARN": "string", "NotificationPolicy": "string", "ObjectACL": "string", "OplocksEnabled": boolean, "Path": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Role": "string", "SMBACLEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "ValidUserList": [ "string" ], "VPCEndpointDNSName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SMBFileShareInfoList An array containing a description for each requested ﬁle share. Response Elements API Version 2013-06-30 212 Storage Gateway API Reference Type: Array of SMBFileShareInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Describe an SMB ﬁle share In the following request, you get the description for a single SMB ﬁle share identiﬁed by its Amazon Resource Name (ARN). Sample Request { "FileShareARNList": [ "arn:aws:storagegateway:us-east-2:204469490176:share/share-XXXXXX" ] } Sample Response { "SMBFileShareInfoList": [ { "Authentication": "ActiveDirectory", Errors API Version 2013-06-30 213 Storage Gateway API Reference "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share- XXXXXXXX", "FileShareId": "share-XXXXXXXX", "FileShareStatus": "AVAILABLE", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw- YYYYYYYY", "GuessMIMETypeEnabled": "true", "InvalidUserList": [ "user1", "user2" ], "KMSEncrypted": "false", "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket", "ObjectACL": "bucket-owner-full-control", "Path": "/my-path-alpha", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ValidUserList": [ "user3", "user4" ] } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2013-06-30 214 Storage Gateway • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 215 Storage Gateway API Reference DescribeSMBSettings Gets a description of a Server Message Block (SMB) ﬁle share settings from a ﬁle gateway. This operation is only supported for ﬁle gateways. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "ActiveDirectoryStatus": "string", "DomainName": "string", "FileSharesVisible": boolean, "GatewayARN": "string", "SMBGuestPasswordSet": boolean, "SMBLocalGroups": { "GatewayAdmins": [ "string" ] }, "SMBSecurityStrategy": "string" DescribeSMBSettings API Version 2013-06-30 216 Storage Gateway } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ActiveDirectoryStatus Indicates the status of a gateway that is a member of the Active Directory domain. Note This ﬁeld is only used as part of a JoinDomain request. It is not aﬀected by Active Directory connectivity changes that occur after the JoinDomain request succeeds. • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error. • DETACHED: Indicates that gateway is not joined to a domain. • JOINED: Indicates that the gateway has successfully joined a domain. • JOINING: Indicates that a JoinDomain operation is in progress. • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error. • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time. • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error. Type: String Valid Values: ACCESS_DENIED \|
storagegateway-api-048	storagegateway-api.pdf	48	the JoinDomain request succeeds. • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error. • DETACHED: Indicates that gateway is not joined to a domain. • JOINED: Indicates that the gateway has successfully joined a domain. • JOINING: Indicates that a JoinDomain operation is in progress. • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error. • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time. • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error. Type: String Valid Values: ACCESS_DENIED \| DETACHED \| JOINED \| JOINING \| NETWORK_ERROR \| TIMEOUT \| UNKNOWN_ERROR DomainName The name of the domain that the gateway is joined to. Type: String Response Elements API Version 2013-06-30 217 Storage Gateway API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$ FileSharesVisible The shares on this gateway appear when listing shares. Only supported for S3 File Gateways. Type: Boolean GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. SMBGuestPasswordSet This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways. Valid Values: true \| false Type: Boolean SMBLocalGroups A list of Active Directory users and groups that have special permissions for SMB ﬁle shares on the gateway. Type: SMBLocalGroups object SMBSecurityStrategy The type of security strategy that was speciﬁed for ﬁle gateway. • ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across diﬀerent clients in your environment. Supported only for S3 File Gateway. • MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later. Response Elements API Version 2013-06-30 218 Storage Gateway API Reference • MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later. • MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later. Type: String Valid Values: ClientSpecified \| MandatorySigning \| MandatoryEncryption \| MandatoryEncryptionNoAes128 Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2013-06-30 219 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 220 Storage Gateway API Reference DescribeSnapshotSchedule Describes the snapshot schedule for the speciﬁed gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types. Request Syntax { "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "Description": "string", "RecurrenceInHours": number, "StartAt": number, "Tags": [ { DescribeSnapshotSchedule API Version 2013-06-30 221 Storage Gateway API Reference "Key": "string", "Value": "string" } ], "Timezone": "string", "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Description The snapshot description. Type: String Length Constraints: Minimum length of 1.
storagegateway-api-049	storagegateway-api.pdf	49	the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "Description": "string", "RecurrenceInHours": number, "StartAt": number, "Tags": [ { DescribeSnapshotSchedule API Version 2013-06-30 221 Storage Gateway API Reference "Key": "string", "Value": "string" } ], "Timezone": "string", "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Description The snapshot description. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. RecurrenceInHours The number of hours between snapshots. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. StartAt The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Tags A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. Response Elements API Version 2013-06-30 222 Storage Gateway Type: Array of Tag objects Timezone A value that indicates the time zone of the gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 10. VolumeARN API Reference The Amazon Resource Name (ARN) of the volume that was speciﬁed in the request. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request that retrieves the snapshot schedule for a volume. Errors API Version 2013-06-30 223 Storage Gateway Sample Request POST / HTTP/1.1 API Reference Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeSnapshotSchedule { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 211 { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB", "StartAt": "6", "RecurrenceInHours": "24", "Description": "sgw-AABB1122:vol-AABB1122:Schedule", "Timezone": "GMT+7:00" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2013-06-30 224 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 225 Storage Gateway API Reference DescribeStorediSCSIVolumes Returns the description of the gateway volumes speciﬁed in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type. Request Syntax { "VolumeARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARNs An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the speciﬁed stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: Yes Response Syntax { "StorediSCSIVolumes": [ { "CreatedDate": number, DescribeStorediSCSIVolumes API Version 2013-06-30 226 Storage Gateway API Reference "KMSKey": "string", "PreservedExistingData": boolean, "SourceSnapshotId": "string", "TargetName": "string", "VolumeARN": "string", "VolumeAttachmentStatus": "string", "VolumeDiskId": "string", "VolumeId": "string", "VolumeiSCSIAttributes": { "ChapEnabled": boolean, "LunNumber": number, "NetworkInterfaceId": "string", "NetworkInterfacePort": number, "TargetARN": "string" }, "VolumeProgress": number, "VolumeSizeInBytes": number, "VolumeStatus": "string", "VolumeType": "string", "VolumeUsedInBytes": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. StorediSCSIVolumes Describes a single unit of output from DescribeStorediSCSIVolumes. The following ﬁelds are returned: • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target. • LunNumber: The logical disk number. • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target. • NetworkInterfacePort: The port used
storagegateway-api-050	storagegateway-api.pdf	50	"string" }, "VolumeProgress": number, "VolumeSizeInBytes": number, "VolumeStatus": "string", "VolumeType": "string", "VolumeUsedInBytes": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. StorediSCSIVolumes Describes a single unit of output from DescribeStorediSCSIVolumes. The following ﬁelds are returned: • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target. • LunNumber: The logical disk number. • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target. • NetworkInterfacePort: The port used to communicate with iSCSI targets. • PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved. Response Elements API Version 2013-06-30 227 Storage Gateway API Reference • SourceSnapshotId: If the stored volume was created from a snapshot, this ﬁeld contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this ﬁeld is not included. • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume. • TargetARN: The Amazon Resource Name (ARN) of the volume target. • VolumeARN: The Amazon Resource Name (ARN) of the stored volume. • VolumeDiskId: The disk ID of the local disk that was speciﬁed in the CreateStorediSCSIVolume operation. • VolumeId: The unique identiﬁer of the storage volume, e.g. vol-1122AABB. • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. • VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This ﬁeld does not appear in the response if the stored volume is not restoring or bootstrapping. • VolumeSizeInBytes: The size of the volume in bytes. • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume. • VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported. Type: Array of StorediSCSIVolume objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. Errors API Version 2013-06-30 228 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example shows a request that returns a description of a volume. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeStorediSCSIVolumes { "VolumeARNs": [ "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/ vol-1122AABB" ] } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 507 { "StorediSCSIVolumes": [ { "VolumeiSCSIAttributes": { "ChapEnabled": "true", "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": "3260", "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, Examples API Version 2013-06-30 229 Storage Gateway API Reference "KMSEncrypted": "false", "PreservedExistingData": "false", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/ sgw-12A3456B/volume/vol-1122AABB", "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "VolumeId": "vol-1122AABB", "VolumeProgress": "23.7", "VolumeSizeInBytes": "1099511627776", "VolumeStatus": "BOOTSTRAPPING", "VolumeUsedInBytes": "1090000000000" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 230 Storage Gateway API Reference DescribeTapeArchives Returns a description of speciﬁed virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a speciﬁc TapeARN is not speciﬁed, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. Request Syntax { "Limit": number, "Marker": "string", "TapeARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Limit Speciﬁes that the number of virtual tapes described be limited to the speciﬁed number. Type: Integer Valid Range: Minimum value of 1. Required: No Marker An opaque string that indicates the position at which to begin describing virtual tapes. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No DescribeTapeArchives API Version 2013-06-30 231 Storage Gateway TapeARNs API Reference Speciﬁes one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: No Response Syntax { "Marker": "string", "TapeArchives": [ { "CompletionTime": number, "KMSKey": "string", "PoolEntryDate": number, "PoolId": "string", "RetentionStartDate": number, "RetrievedTo": "string", "TapeARN": "string", "TapeBarcode": "string", "TapeCreatedDate": number, "TapeSizeInBytes": number, "TapeStatus":
storagegateway-api-051	storagegateway-api.pdf	51	indicates the position at which to begin describing virtual tapes. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No DescribeTapeArchives API Version 2013-06-30 231 Storage Gateway TapeARNs API Reference Speciﬁes one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: No Response Syntax { "Marker": "string", "TapeArchives": [ { "CompletionTime": number, "KMSKey": "string", "PoolEntryDate": number, "PoolId": "string", "RetentionStartDate": number, "RetrievedTo": "string", "TapeARN": "string", "TapeBarcode": "string", "TapeCreatedDate": number, "TapeSizeInBytes": number, "TapeStatus": "string", "TapeUsedInBytes": number, "Worm": boolean } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-06-30 232 Storage Gateway Marker API Reference An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this ﬁeld does not appear in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. TapeArchives An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode. Type: Array of TapeArchive objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Errors API Version 2013-06-30 233 Storage Gateway Examples Retrieve description tapes in VTS API Reference The following example shows a request that retrieves description of two tapes archived to VTS in the AWS Region speciﬁed in the request. The request identiﬁes the tapes by their ARN value. The trailing string in the ARN is the tape barcode. If you don't provide the tape ARN, the tape gateway returns information about all tapes archived to VTS. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20131028T120000Z x-amz-target: StorageGateway_20130630.DescribeTapeArchives { "TapeARNs": [ "arn:aws:storagegateway:us-east-2:999999999999:tape/AM08A1AD", "arn:aws:storagegateway:us-east-2:999999999999:tape/AMZN01A2A4" ] } Sample Response { "TapeArchives": [ { "CompletionTime": "1380308527.236", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/ b72aaa2a-2222-99tt-12345690qwe", "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AM08A1AD", "TapeBarcode": "AM08A1AD", "TapeSizeInBytes": "107374182400", "TapeStatus": "ARCHIVED" }, { "CompletionTime": "1382918022.647", Examples API Version 2013-06-30 234 Storage Gateway API Reference "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AMZN01A2A4", "TapeBarcode": "AMZN01A2A4", "TapeSizeInBytes": "429496729600", "TapeStatus": "ARCHIVED" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 235 Storage Gateway API Reference DescribeTapeRecoveryPoints Returns a list of virtual tape recovery points that are available for the speciﬁed tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type. Request Syntax { "GatewayARN": "string", "Limit": number, "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Limit Speciﬁes that the number of virtual tape recovery points that are described be limited to the speciﬁed number. Type: Integer Valid Range: Minimum value of 1. DescribeTapeRecoveryPoints API Version 2013-06-30 236 Storage Gateway Required: No Marker API Reference An opaque string that indicates the position at which to begin describing the virtual tape recovery points. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No Response Syntax { "GatewayARN": "string", "Marker": "string", "TapeRecoveryPointInfos": [ { "TapeARN": "string", "TapeRecoveryPointTime": number, "TapeSizeInBytes": number, "TapeStatus": "string" } ] } Response Elements If the action
storagegateway-api-052	storagegateway-api.pdf	52	of 500. Required: Yes Limit Speciﬁes that the number of virtual tape recovery points that are described be limited to the speciﬁed number. Type: Integer Valid Range: Minimum value of 1. DescribeTapeRecoveryPoints API Version 2013-06-30 236 Storage Gateway Required: No Marker API Reference An opaque string that indicates the position at which to begin describing the virtual tape recovery points. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No Response Syntax { "GatewayARN": "string", "Marker": "string", "TapeRecoveryPointInfos": [ { "TapeARN": "string", "TapeRecoveryPointTime": number, "TapeSizeInBytes": number, "TapeStatus": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Response Syntax API Version 2013-06-30 237 Storage Gateway Marker API Reference An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended. Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this ﬁeld does not appear in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. TapeRecoveryPointInfos An array of TapeRecoveryPointInfos that are available for the speciﬁed gateway. Type: Array of TapeRecoveryPointInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2013-06-30 238 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 239 Storage Gateway DescribeTapes API Reference Returns a description of virtual tapes that correspond to the speciﬁed Amazon Resource Names (ARNs). If TapeARN is not speciﬁed, returns a description of the virtual tapes associated with the speciﬁed gateway. This operation is only supported for the tape gateway type. The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit ﬁeld in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker ﬁeld. You can use this Marker value in your subsequent request to retrieve the next set of tapes. Request Syntax { "GatewayARN": "string", "Limit": number, "Marker": "string", "TapeARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Limit Speciﬁes that the number of virtual tapes described be limited to the speciﬁed number. DescribeTapes API Version 2013-06-30 240 Storage Gateway Note Amazon Web Services may impose its own limit, if this ﬁeld is not set. API Reference Type: Integer Valid Range: Minimum value of 1. Required: No Marker A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve. If not speciﬁed, the ﬁrst page of results is retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No TapeARNs Speciﬁes one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not speciﬁed, Tape gateway returns a description of all virtual tapes associated with the speciﬁed gateway. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: No Response Syntax { "Marker": "string", "Tapes": [ Response Syntax API Version 2013-06-30 241 Storage Gateway API Reference { "KMSKey": "string", "PoolEntryDate": number, "PoolId": "string", "Progress": number, "RetentionStartDate": number, "TapeARN": "string", "TapeBarcode": "string", "TapeCreatedDate": number, "TapeSizeInBytes": number, "TapeStatus": "string", "TapeUsedInBytes": number, "VTLDevice": "string", "Worm": boolean } ]
storagegateway-api-053	storagegateway-api.pdf	53	more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not speciﬁed, Tape gateway returns a description of all virtual tapes associated with the speciﬁed gateway. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$ Required: No Response Syntax { "Marker": "string", "Tapes": [ Response Syntax API Version 2013-06-30 241 Storage Gateway API Reference { "KMSKey": "string", "PoolEntryDate": number, "PoolId": "string", "Progress": number, "RetentionStartDate": number, "TapeARN": "string", "TapeBarcode": "string", "TapeCreatedDate": number, "TapeSizeInBytes": number, "TapeStatus": "string", "TapeUsedInBytes": number, "VTLDevice": "string", "Worm": boolean } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Marker An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Tapes An array of virtual tape descriptions. Type: Array of Tape objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2013-06-30 242 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Get descriptions of speciﬁc tapes In the following request you obtain descriptions of tapes in the tape gateway with ID sgw-12A3456B. The request identiﬁes speciﬁc tapes by specifying ARNs for the tapes. In the ARN, the trailing string, for example "TEST04A2A1"- is the tape barcode value. The string 999999999999 is your account number. Sample Request { "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B", "TapeARNs": [ "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST04A2A1", "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST05A2A0" ] } Sample Response { "Tapes": [ { "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST04A2A1", "TapeBarcode": "TEST04A2A1", "TapeSizeInBytes": "107374182400", Examples API Version 2013-06-30 243 Storage Gateway API Reference "TapeStatus": "AVAILABLE" }, { "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST05A2A0", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/ b72aaa2a-2222-99tt-12345690qwe", "TapeBarcode": "TEST05A2A0", "TapeSizeInBytes": "107374182400", "TapeStatus": "AVAILABLE" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 244 Storage Gateway API Reference DescribeUploadBuﬀer Returns information about the upload buﬀer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are conﬁgured as upload buﬀer space, and it includes the amount of upload buﬀer space allocated and used. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "DiskIds": [ "string" ], "GatewayARN": "string", "UploadBufferAllocatedInBytes": number, "UploadBufferUsedInBytes": number } DescribeUploadBuﬀer API Version 2013-06-30 245 Storage Gateway Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DiskIds An array of the gateway's local disk IDs that are conﬁgured as working storage. Each local disk ID is speciﬁed as a string (minimum length of 1 and maximum length of 300). If no local disks are conﬁgured as working storage, then the DiskIds array is empty. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. UploadBuﬀerAllocatedInBytes The total number of bytes allocated in the gateway's as upload buﬀer. Type: Long UploadBuﬀerUsedInBytes The total number of bytes being used in the gateway's upload buﬀer. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 246 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception
storagegateway-api-054	storagegateway-api.pdf	54	gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. UploadBuﬀerAllocatedInBytes The total number of bytes allocated in the gateway's as upload buﬀer. Type: Long UploadBuﬀerUsedInBytes The total number of bytes being used in the gateway's upload buﬀer. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. Response Elements API Version 2013-06-30 246 Storage Gateway API Reference HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request to obtain a description of a gateway's working storage. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20130630.DescribeUploadBuffer { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0 Date: Wed, 12 Sep 2012 12:00:02 GMT Content-Type: application/x-amz-json-1.1 Content-length: 271 { "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0" Examples API Version 2013-06-30 247 Storage Gateway ], API Reference "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "UploadBufferAllocatedInBytes": "161061273600", "UploadBufferUsedInBytes": "0" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 248 Storage Gateway API Reference DescribeVTLDevices Returns a description of virtual tape library (VTL) devices for the speciﬁed tape gateway. In the response, Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type. Request Syntax { "GatewayARN": "string", "Limit": number, "Marker": "string", "VTLDeviceARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Limit Speciﬁes that the number of VTL devices described be limited to the speciﬁed number. Type: Integer Valid Range: Minimum value of 1. Required: No DescribeVTLDevices API Version 2013-06-30 249 Storage Gateway Marker API Reference An opaque string that indicates the position at which to begin describing the VTL devices. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No VTLDeviceARNs An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. Note All of the speciﬁed VTL devices must be from the same gateway. If no VTL devices are speciﬁed, the result will contain all devices on the speciﬁed gateway. Type: Array of strings Length Constraints: Minimum length of 50. Maximum length of 500. Required: No Response Syntax { "GatewayARN": "string", "Marker": "string", "VTLDevices": [ { "DeviceiSCSIAttributes": { "ChapEnabled": boolean, "NetworkInterfaceId": "string", "NetworkInterfacePort": number, "TargetARN": "string" }, "VTLDeviceARN": "string", Response Syntax API Version 2013-06-30 250 Storage Gateway API Reference "VTLDeviceProductIdentifier": "string", "VTLDeviceType": "string", "VTLDeviceVendor": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Marker An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this ﬁeld does not appear in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. VTLDevices An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices. Type: Array of VTLDevice objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2013-06-30 251 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Get descriptions
storagegateway-api-055	storagegateway-api.pdf	55	An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices. Type: Array of VTLDevice objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2013-06-30 251 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Get descriptions of the VTL devices on a gateway The following example gets descriptions of all the VTL devices on a gateway with ID sgw-12A3456B. The request identiﬁes the gateway by ARN. In the request, string 999999999999 is the account number associated with the AWS account sending the request. Note that the response shown is truncated, it shows the media changer and only two tape drives. The trailing string in each device ARN is the device ID. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20131025T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeVTLDevices { "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B" } Sample Response { "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B", "VTLDevices": [ Examples API Version 2013-06-30 252 Storage Gateway { "DeviceiSCSIAttributes": { "ChapEnabled": "false", "NetworkInterfaceId": "", "NetworkInterfacePort": "3260", API Reference "TargetARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", "VTLDeviceProductIdentifier": "L700", "VTLDeviceType": "Medium Changer", "VTLDeviceVendor": "STK" }, { "DeviceiSCSIAttributes": { "ChapEnabled": "false", "NetworkInterfaceId": "", "NetworkInterfacePort": "3260", "TargetARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", "VTLDeviceProductIdentifier": "ULT3580-TD5", "VTLDeviceType": "Tape Drive", "VTLDeviceVendor": "IBM" }, { "DeviceiSCSIAttributes": { "ChapEnabled": "false", "NetworkInterfaceId": "*", "NetworkInterfacePort": "3260", "TargetARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/ sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", "VTLDeviceProductIdentifier": "ULT3580-TD5", "VTLDeviceType": "Tape Drive", "VTLDeviceVendor": "IBM" } ] Examples API Version 2013-06-30 253 Storage Gateway } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 254 Storage Gateway API Reference DescribeWorkingStorage Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuﬀer instead. Note Working storage is also referred to as upload buﬀer. You can also use the DescribeUploadBuﬀer operation to add upload buﬀer to a stored volume gateway. The response includes disk IDs that are conﬁgured as working storage, and it includes the amount of working storage allocated and used. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes DescribeWorkingStorage API Version 2013-06-30 255 API Reference Storage Gateway Response Syntax { "DiskIds": [ "string" ], "GatewayARN": "string", "WorkingStorageAllocatedInBytes": number, "WorkingStorageUsedInBytes": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DiskIds An array of the gateway's local disk IDs that are conﬁgured as working storage. Each local disk ID is speciﬁed as a string (minimum length of 1 and maximum length of 300). If no local disks are conﬁgured as working storage, then the DiskIds array is empty. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 300. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. WorkingStorageAllocatedInBytes The total working storage in bytes allocated for the gateway. If no working storage is conﬁgured for the gateway, this ﬁeld returns 0. Type: Long WorkingStorageUsedInBytes The total working storage in bytes in use by the gateway. If no working storage is conﬁgured for the gateway, this ﬁeld returns 0. Response Syntax API Version 2013-06-30 256 Storage Gateway Type: Long Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message
storagegateway-api-056	storagegateway-api.pdf	56	0. Type: Long WorkingStorageUsedInBytes The total working storage in bytes in use by the gateway. If no working storage is conﬁgured for the gateway, this ﬁeld returns 0. Response Syntax API Version 2013-06-30 256 Storage Gateway Type: Long Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 Examples Example request The following example shows a request to obtain a description of a gateway's working storage. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DescribeWorkingStorage { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } Sample Response HTTP/1.1 200 OK Errors API Version 2013-06-30 257 Storage Gateway API Reference x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 241 { "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ], "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "WorkingStorageAllocatedInBytes": "2199023255552", "WorkingStorageUsedInBytes": "789207040" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 258 Storage Gateway DetachVolume API Reference Disconnects a volume from an iSCSI connection and then detaches the volume from the speciﬁed gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a diﬀerent gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type. Request Syntax { "ForceDetach": boolean, "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ForceDetach Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume. Valid Values: true \| false Type: Boolean Required: No VolumeARN The Amazon Resource Name (ARN) of the volume to detach from the gateway. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) DetachVolume API Version 2013-06-30 259 API Reference Storage Gateway Required: Yes Response Syntax { "VolumeARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. VolumeARN The Amazon Resource Name (ARN) of the volume that was detached. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Pattern: arn:(aws(\|-cn\|-us-gov\|-iso[A-Za-z0-9_-])):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. Response Syntax API Version 2013-06-30 260 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example shows a request that detaches a volume from a gateway. Sample Request POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20181025T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.DetachVolume { "ForceDetach": "false", "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } Sample Response HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Thu, 25 Oct 2018 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: { "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2013-06-30 261 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 262 Storage Gateway DisableGateway API Reference Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway
storagegateway-api-057	storagegateway-api.pdf	57	Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 262 Storage Gateway DisableGateway API Reference Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. Important After a gateway is disabled, it cannot be enabled. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { DisableGateway API Version 2013-06-30 263 API Reference Storage Gateway "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN The unique Amazon Resource Name (ARN) of the disabled gateway. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-06-30 264 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 265 Storage Gateway API Reference DisassociateFileSystem Disassociates an Amazon FSx ﬁle system from the speciﬁed gateway. After the disassociation process ﬁnishes, the gateway can no longer access the Amazon FSx ﬁle system. This operation is only supported in the FSx File Gateway type. Request Syntax { "FileSystemAssociationARN": "string", "ForceDelete": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileSystemAssociationARN The Amazon Resource Name (ARN) of the ﬁle system association to be deleted. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes ForceDelete If this value is set to true, the operation disassociates an Amazon FSx ﬁle system immediately. It ends all data uploads to the ﬁle system, and the ﬁle system association enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx ﬁle system does not disassociate until all data is uploaded. Type: Boolean Required: No DisassociateFileSystem API Version 2013-06-30 266 API Reference Storage Gateway Response Syntax { "FileSystemAssociationARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FileSystemAssociationARN The Amazon Resource Name (ARN) of the deleted ﬁle system association. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Response Syntax API Version 2013-06-30 267 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 268 Storage Gateway API Reference EvictFilesFailingUpload Starts a process that cleans the speciﬁed ﬁle share's cache of ﬁle entries
storagegateway-api-058	storagegateway-api.pdf	58	API in one of the language-speciﬁc AWS SDKs, see the following: Response Syntax API Version 2013-06-30 267 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 268 Storage Gateway API Reference EvictFilesFailingUpload Starts a process that cleans the speciﬁed ﬁle share's cache of ﬁle entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the speciﬁed ﬁle share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notiﬁcations. Important If ForceRemove is set to True, the cache clean operation will delete ﬁle data from the gateway which might otherwise be recoverable. We recommend using this operation only after all other methods to clear ﬁles failing upload have been exhausted, and if your business need outweighs the potential data loss. Request Syntax { "FileShareARN": "string", "ForceRemove": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARN The Amazon Resource Name (ARN) of the ﬁle share for which you want to start the cache clean operation. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes EvictFilesFailingUpload API Version 2013-06-30 269 Storage Gateway ForceRemove API Reference Speciﬁes whether cache entries with full or partial ﬁle data currently stored on the gateway will be forcibly removed by the cache clean operation. Valid arguments: • False - The cache clean operation skips cache entries failing upload if they are associated with data currently stored on the gateway. This preserves the cached data. • True - The cache clean operation removes cache entries failing upload even if they are associated with data currently stored on the gateway. This deletes the cached data. Important If ForceRemove is set to True, the cache clean operation will delete ﬁle data from the gateway which might otherwise be recoverable. Type: Boolean Required: No Response Syntax { "NotificationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NotiﬁcationId The randomly generated ID of the CloudWatch notiﬁcation associated with the cache clean operation. This ID is in UUID format. Type: String Response Syntax API Version 2013-06-30 270 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message ﬁelds. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message ﬁelds. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 271 Storage Gateway JoinDomain API Reference Adds a ﬁle gateway to an Active Directory domain. This operation is only supported for ﬁle gateways that support the SMB ﬁle protocol. Note Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time. To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain. Request Syntax { "DomainControllers": [ "string" ], "DomainName": "string", "GatewayARN": "string", "OrganizationalUnit": "string", "Password": "string", "TimeoutInSeconds": number, "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainControllers List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389. Type: Array of strings JoinDomain API Version 2013-06-30 272 Storage Gateway API Reference Length Constraints: Minimum length of 6.

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.